[COMPASS-4147] Automated jsdocs in README's Created: 12/Feb/20  Updated: 10/Jan/24  Resolved: 30/Jun/22

Status: Closed
Project: Compass
Component/s: Tech debt
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Major - P3
Reporter: Lucas Hrabovsky (Inactive) Assignee: Unassigned
Resolution: Won't Do Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   
  • We have a lot of context on implementation buried in our JS docs (e.g. import export) that would be valuable to productivity if discoverable. Scripts to include structured jsdoc in README.md's is the most direct for our workflows.

via maurizio.casimirri

```
npm i --save-dev markdown-toc jsdoc2md node-injectmd
```
#### package.json scripts
```
"docs": "npm run docs:jsdoc && npm run docs:toc",
"docs:toc": "markdown-toc -i README.md",
"docs:jsdoc": "jsdoc2md -d 3 -c .jsdocrc lib/**/*.js | node-injectmd -t docs -i README.md",
```
#### README.md
``` md
<!-- toc -->
<!-- tocstop -->
# Api
```


Generated at Wed Feb 07 22:35:25 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.