Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Drop component readme files from the monorepo #10725

Open
jcfranco opened this issue Nov 13, 2024 · 3 comments
Open

Drop component readme files from the monorepo #10725

jcfranco opened this issue Nov 13, 2024 · 3 comments
Labels
0 - new New issues that need assignment. docs Issues relating to documentation updates only. estimate - 2 Small fix or update, may require updates to tests. needs milestone Planning workflow - pending milestone assignment, has priority and/or estimate. p - low Issue is non core or affecting less that 10% of people using the library

Comments

@jcfranco
Copy link
Member

Description

The documentation site has served as the primary documentation source for our components, making these files no longer necessary to keep and maintain. Since Lumina does not generate these readmes, creating them would require additional effort that doesn't seem worth it at this point.

cc @geospatialem @DitwanP @benelan @macandcheese

Which Component

All readme files.

Resources

No response

@jcfranco jcfranco added docs Issues relating to documentation updates only. 0 - new New issues that need assignment. needs triage Planning workflow - pending design/dev review. labels Nov 13, 2024
@driskull
Copy link
Member

Maybe in the future we could have something else to tell us the dependencies info.

## Dependencies
### Depends on
- [calcite-scrim](../scrim)
- [calcite-stack](../stack)
- [calcite-filter](../filter)
### Graph
```mermaid
graph TD;
calcite-list --> calcite-scrim
calcite-list --> calcite-stack
calcite-list --> calcite-filter
calcite-scrim --> calcite-loader
calcite-filter --> calcite-input
calcite-input --> calcite-progress
calcite-input --> calcite-icon
calcite-input --> calcite-input-message
calcite-input-message --> calcite-icon
style calcite-list fill:#f9f,stroke:#333,stroke-width:4px
```

@jcfranco
Copy link
Member Author

We might be able to extract that info from the Vite build. cc @maxpatiiuk

@maxpatiiuk
Copy link
Member

you should be able to extract this information from the context._customElementDependencies property.
the property is present in the typings, but marked as private via JSDoc - I can expose it if you need it.
you can get the reference to the Lumina's context object like so, among other ways:

// vite.config.ts
const lumina = useLumina({ ... } );
const context = lumina.context;
export default defineConfig({
  plugins: [lumina],
});

@driskull driskull changed the title Drop component readmes from the monorepo Drop component readme files from the monorepo Feb 25, 2025
@driskull driskull added p - low Issue is non core or affecting less that 10% of people using the library estimate - 1 Very small fix or change (potentially a single line), doesn't require updates to tests. estimate - 2 Small fix or update, may require updates to tests. and removed estimate - 1 Very small fix or change (potentially a single line), doesn't require updates to tests. labels Feb 25, 2025
@DitwanP DitwanP added needs milestone Planning workflow - pending milestone assignment, has priority and/or estimate. and removed needs triage Planning workflow - pending design/dev review. labels Feb 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0 - new New issues that need assignment. docs Issues relating to documentation updates only. estimate - 2 Small fix or update, may require updates to tests. needs milestone Planning workflow - pending milestone assignment, has priority and/or estimate. p - low Issue is non core or affecting less that 10% of people using the library
Projects
None yet
Development

No branches or pull requests

4 participants