opensafely / opensafely/documentation
Audit documentation we have
Open
Nobody has claimed this yet.
question
- Dominant language
- Python
- Stars
- 48
- Forks
- 10
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 17
Description
- Where it is?
- Who owns it?
- When was it last revised?
- How is it discoverable?
- Is deprecated information marked as such?
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
No files, tests, or entry points are named. Begin by locating the repository’s documentation inventory and assess each item for location, ownership, revision date, discoverability, and deprecated-content marking; done means the audit results are recorded and gaps are identified.
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
- Needs clarification
- Newbie friendliness
- 30/100