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.

Sign up for GitHub

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

Jump to bottom

[charts][docs-infra] Document interfaces in dedicated pages #12380

Closed
alexfauquette opened this issue Mar 8, 2024 · 1 comment · Fixed by #12656
Closed

[charts][docs-infra] Document interfaces in dedicated pages #12380

alexfauquette opened this issue Mar 8, 2024 · 1 comment · Fixed by #12656
Assignees
@alexfauquette
Labels
component: charts This is the name of the generic UI component, not the React module! enhancement This is not a bug, nor a new feature scope: docs-infra Specific to the docs-infra product

Comments

@alexfauquette
Copy link
Member

alexfauquette commented Mar 8, 2024 •
edited by github-actions bot

Some interfaces are quite heavy:

  • Axis configuration
  • Series configuration

For now they are either missing or they pollute the API pages.

The idea would be to document those interfaces in dedicated pages and link to those pages for more information like the data grid is doing for its column definition

Need to merge this PR before: #12016

Search keywords:
@github-actions github-actions bot added the status: waiting for maintainer These issues haven't been looked at yet by a maintainer label Mar 8, 2024
@michelengelen michelengelen added component: charts This is the name of the generic UI component, not the React module! scope: docs-infra Specific to the docs-infra product enhancement This is not a bug, nor a new feature and removed status: waiting for maintainer These issues haven't been looked at yet by a maintainer labels Mar 8, 2024
@alexfauquette alexfauquette self-assigned this Apr 3, 2024
@alexfauquette alexfauquette mentioned this issue Apr 4, 2024
Merged
@github-actions GitHub Actions
Copy link

⚠️ This issue has been closed. If you have a similar problem but not exactly the same, please open a new issue.
Now, if you have additional information related to this issue or things that could help future readers, feel free to leave a comment.

@alexfauquette: How did we do? Your experience with our support team matters to us. If you have a moment, please share your thoughts in this short Support Satisfaction survey.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@alexfauquette alexfauquette

Labels
component: charts This is the name of the generic UI component, not the React module! enhancement This is not a bug, nor a new feature scope: docs-infra Specific to the docs-infra product
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[docs] Document interfaces for charts alexfauquette/mui-x
2 participants
@michelengelen @alexfauquette