tutorbook icon indicating copy to clipboard operation
tutorbook copied to clipboard

Automatically generate low-level documentation

Open nicholaschiang opened this issue 5 years ago • 2 comments
trafficstars

We want to automatically generate our documentation after every git push (likely using GitHub Actions or our Travis-CI) that parses:

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.

nicholaschiang avatar Mar 31 '20 20:03 nicholaschiang

See this repository for some more developments (adapting our JSDoc Minami theme for use with Typedoc).

nicholaschiang avatar Apr 15 '20 21:04 nicholaschiang

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.

nicholaschiang avatar Aug 25 '20 17:08 nicholaschiang