makeitcount / makeitcount/saas-express-starter-kit
Add script to convert comments to docs using jsdoc
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 55
- Forks
- 13
- PR merge metrics
- No merged PRs in 30d
Description
Create an npm script `npm docs` that will export all the comments and make it available as html page at `/docs/reference` endpoint. We are already writing jsdoc supported comments, use [jsdoc npm package](https://jsdoc.app/) now to convert those comments to html
I think, following should fix it
1. Install jsdoc as dev dependency `npm install --save-dev jsdoc`
2. Create docs-config.json with source including all js files in the project and destination to be `public/docs/references` (read about jsdoc configs [here](https://jsdoc.app/about-configuring-jsdoc.html#default-configuration-options))
3. Add script in package.json `scripts : { docs : "./node_modules/.bin/jsdoc -c ./docs-config.json"}`
4. Test the route `/docs/references`
5. Look for further improvements in docs navigation and then commit the docs folder
Resources
- [jsdoc command line references](https://jsdoc.app/about-commandline.html)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with package.json and the code handling the proposed /docs/references endpoint, then review the JSDoc configuration guidance. Add docs-config.json and the npm docs script so the project’s JavaScript comments generate HTML; done means the generated documentation is served at the requested route and the route is tested.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- express, javascript, nodejs
- Domain
- backend, documentation, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100