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

Collocate docs with source code #63

Open
4 tasks
alirezamirian opened this issue Sep 15, 2024 · 0 comments
Open
4 tasks

Collocate docs with source code #63

alirezamirian opened this issue Sep 15, 2024 · 0 comments

Comments

@alirezamirian
Copy link
Owner

Should be done after #62.

Each component has an mdx file which is now living under docs folder in website package. They should each be moved next to the source code for that component, so code, tests, examples, and documentation are all collocated for each component.
The rest of the docs should be moved into a docs folder next to src.

  • Update component template accordingly.
  • Move component mdx files from website/docs/components to the component folder where source, tests, and examples are. Some internal linking needs to be updated too.
  • Add flexibleSidebarItemGenerator to generate "components" sidebar based on category metadata in docs, rather than their path. (flexibleSidebarItemGenerator is planned to be published as a separate package).
  • Include other docs from a docs folder, either in website, or in the library, next to src folder.
@alirezamirian alirezamirian changed the title Collocate docs with source code. Collocate docs with source code Sep 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant