BentleyJOakes
commented
2 years ago - [x] Align installation steps in documentation with README.
- Documentation should just point to README file in folder/repo. This prevents duplication of information.
- [x] Add link to source code and issue tracker to first page of documentation
- [ ] Fix up documentation such that JSDoc can extract it
- See about-getting-started.html for basic usage
- See about-configuring-jsdoc.html for info about not ignoring files like _worker.js
- See howto-commonjs-modules.html for info about comments in Node.js modules
- [ ] Investigate possibility of using sphinx-js to extract documentation into online docs
- [ ] Automate this extraction (on ReadTheDocs side)
- [ ] Organize documentation based on principles from diataxis