Improve documentation of checks
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 210
- Forks
- 36
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 2
Description
Right now we use a table on the first page of the documentation website to describe the checks, which is very brief and needs improvement. We should add a page per check to explain the rules and security properties more intuitively.
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 with the current checks table on the documentation website and review how the existing documentation is organized. Identify each listed check and document its rules and security properties in an individual page, with links from the table or first page. Done means every check has an intuitive, sufficiently detailed page.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100