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

Propose standard and set up framework for technical documentation within the monorepo #6795

Open
brent-hoover opened this issue Feb 14, 2023 · 0 comments
Labels
core work For issues that track feature development work being done by core Reaction developers documentation For issues that describe mistakes in documentation or missing docs, including in code comments

Comments

@brent-hoover
Copy link
Collaborator

From a suggestion from @aldeed, we are going to start building technical documentation within the monorepo including a local command that will launching a searchable "mini docs site" that is focused on developer documentation. Work should include initial research work, do getting the chosen framework working, creating a plan for documentation (structure, which pieces should be documented, etc) but does not include writing all the docs, which is work that should be distributed amongst the team.

@brent-hoover brent-hoover added documentation For issues that describe mistakes in documentation or missing docs, including in code comments core work For issues that track feature development work being done by core Reaction developers labels Feb 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core work For issues that track feature development work being done by core Reaction developers documentation For issues that describe mistakes in documentation or missing docs, including in code comments
Projects
None yet
Development

No branches or pull requests

1 participant