opensafely-core / opensafely-core/reports
Easier navigation within reports
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 0
- Forks
- 1
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 5
Description
Both the Vaccine Coverage and SRO Measures reports have tables of contents to allow readers to find the bits they are interested in. They are a bit clunky to use because they require the reader to scroll up to the top of the report -- but not quite the top because there is preamble content before the ToC.
We should think about whether we can make it easier for readers to navigate within a report. Foldable sections? Multi-page reports? Persistent ToC in the margin of the page?
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
Review the Vaccine Coverage and SRO Measures reports and compare how their tables of contents are currently used. Agree on a specific navigation approach before starting; done should mean readers can move within both reports without scrolling back to the table of contents.
Written by the indexing model from the issue text.
Assessment
- Domain
- frontend, web-dev
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100