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

Documentation: unify parent and children docs #280

Open
PavelVanecek opened this issue Oct 9, 2023 · 0 comments
Open

Documentation: unify parent and children docs #280

PavelVanecek opened this issue Oct 9, 2023 · 0 comments

Comments

@PavelVanecek
Copy link
Contributor

What problem does this feature solve?

The website documentation here: https://recharts.org/en-US/api lists for each component where it can be inserted in ("Parent Components") and which sub-components it accepts ("Child Components").

Problem is, this information is not reciprocated and so some components list others as children but the others do not list the first one as their possible parents. Overall it's not something that anyone can reliably use.

What does the proposed API look like?

Have a single object, or a list, with the parent/children relationships. Pull data from that list and put it in the docs so that reciprocating relationships are guaranteed to be represented properly.

Bonus points if the list of parents/children can be clickable with links to the respective documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants