DiamondLightSource / DiamondLightSource/cs-web-lib
Add generated documentation
Open
priority:2
- Dominant language
- TypeScript
- Stars
- 5
- Forks
- 4
- Avg merge
- 3d 59m
- Merged PRs (30d)
- 3
Description
Add a docs build equivalent to the use of Sphinx in the Skeleton.
- Generate API docs based on code comments
- Make space for an introduction page
- How-to for install
- How-to for use in another project
- Make space for architecture decision records
Build with github actions and publish to github pages
My first google result was TypeDoc, but another tool may be more suitable
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.