Can we use documentation.js to autogenerate docs for the utils directory?
Open
Nobody has claimed this yet.
jira-sync-complete
- Dominant language
- TypeScript
- Stars
- 90
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
Handwriting those docs in a Markdown file seems kind of silly, if avoidable.
Contributor guide
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 by reviewing the utils directory and the existing handwritten Markdown documentation, then investigate whether documentation.js supports generating docs for those utilities. Done means the project has an agreed and working approach that avoids manually maintaining the Markdown file.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100