opensafely-core / opensafely-core/opencodelists
Improve discoverability of suggested external tools and explain when they are useful
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 60
- Forks
- 16
- Avg merge
- 4d 12h
- Merged PRs (30d)
- 17
Description
When building a codelist, there are suggested tools to make building a codelist easier. The tools shown depends on the coding system you are building the codelist in. Where they are suggested, there isn't a description of what they're useful for. There's no way to see the suggested tools outside the builder.
It would be useful to have a section in the docs that describes all of the tools that are suggested, the coding systems they can be used for and a short description of why they are useful.
Contributor guide
No contributing guide indexed for this repository
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 by reviewing the codelist builder to identify every suggested external tool and the coding systems where each appears, then check the existing documentation structure for a suitable location. Add a documentation section with each tool, its supported coding systems, and a short explanation of when it is useful; done means the full set of suggested tools can be understood without opening the builder.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100