tutorbook
tutorbook copied to clipboard
Automatically generate low-level documentation
We want to automatically generate our documentation after every git push (likely using GitHub Actions or our Travis-CI) that parses:
- Code comments (like JSDoc does)
- Type annotations (from Typescript)
We'll probably want to use something like react-docgen paired with Docusaurus. Ideally, the styling of the docs should match the styling of our website or Tutorbook's existing documentation that is generated with our @tutorbook/minami theme.
See this repository for some more developments (adapting our JSDoc Minami theme for use with Typedoc).
We'll want this in the future so that developers can easily re-use our React components and context APIs. I really like Vercel's design docs... we'll want to create something similar.