documentation!
- Dominant language
- C++
- Stars
- 197
- Forks
- 37
- PR merge metrics
- No merged PRs in 30d
Description
Documenting this whole thing is going to be epic. A very general, evolving list of things to keep in mind (please edit inline!):
- [ ] All purpose API docs - for now we are not thinking about inline documentation (i.e. documentationjs).
- [ ] API.md
- [ ] C++ examples
- [ ] JS examples
- [ ] installation, os & compiler requirements #48
- [ ] README.md - wat even is this thing #4
- [ ] CONTRIBUTING.md #10
- [ ] developer docs around algorithm choices, code structure, tests, etc. - possibly in a separate repo?
cc @springmeyer @mourner @tcql @flippmoke @jakepruitt @GretaCB @ericfischer
Contributor guide
Research direction
Start with the checklist in this issue and review the referenced API.md, README.md, and CONTRIBUTING.md documentation tasks, along with issues #48, #4, and #10. The scope includes API documentation, C++ and JavaScript examples, installation requirements, and developer documentation about algorithms, structure, and tests; completion is not defined because the list is explicitly evolving.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100