[docs]: Produce Dash version of API reference
- Dominant language
- TypeScript
- Stars
- 12.9k
- Forks
- 4.6k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 74
Description
Got this request from a customer over in the Dev Guide repo. https://github.com/awsdocs/aws-cdk-guide/issues/219
Dash is a native offline browser app for API documentation. It was originally developed for Mac but there are clones of it on other platforms. From a quick Google, it appears the DocSet build tools can accept HTML as input, so it might not be all that much work to support it.
Contributor guide
Research direction
Review the linked awsdocs/aws-cdk-guide issue and investigate how the API reference is currently generated and whether the DocSet build tools accept its HTML output. Done means producing a usable Dash DocSet version of the API reference and documenting the required build process.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100