How to use bit-docs should be part of training
- Dominant language
- JavaScript
- Stars
- 19
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
Think the title is rather self-descriptive, but I think it'd be valuable information to give a quick crash course on using bit-docs to document code in various scenarios; essentially go over all the tags and use them to document real examples, and generate the result.
Probably the best would be to build up from a codebase with no docs and keep showing new tags additively until all tags have been shown/used.
Contributor guide
No contributing guide indexed for this repository
Research direction
No file, test, or entry point is named; start by locating the training material and the bit-docs documentation or tag reference. Done means a crash course builds from undocumented code, demonstrates all tags through real examples, and generates the resulting documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100