documentation tracking issue
Open
High Priority
tracking
- Dominant language
- Python
- Stars
- 6.4k
- Forks
- 1.1k
- PR merge metrics
- No merged PRs in 30d
Description
We should migrate away from github wiki and do the following:
- [ ] move detectors' wiki and detector table to auto-generated markdown in `docs`
- [ ] change format something like https://beta.ruff.rs/docs/rules/bad-quotes-docstring/
- [ ] create a page for each printer and tool
- [ ] create architecture diagram for CONTRIBUTING.md
- [ ] enforce documentation style and add docs where they are missing
This will probably require moving away or adding a separate documentation site as pdoc is best suited for API docs
Contributor guide
Assessment
This issue has not been assessed yet.