Documentation Tools

[chrismclarke]

Depending on requirements, a few possible tools we could use to contribute to overall documentation

Type defintions

• https://typedoc.org/
• https://www.npmjs.com/package/esdoc
• https://jsdoc.app/

Code structure

• https://www.npmjs.com/package/@compodoc/compodoc

UI Components

• https://storybook.js.org/
• https://www.npmjs.com/package/ui-jar

Organising

• https://www.gitbook.com/
• https://readthedocs.org/

Plenty of other options around, open to ideas / further discussion

[chrismclarke]

Recently have enjoyed experimenting with:

• https://docs.astro.build/getting-started/
• https://nextjs.org/
• https://docusaurus.io/

[chrismclarke]

Went ahead with mkdocs in the end