OpenFreeEnergy / OpenFreeEnergy/openfe
[docs] Title headings don't allow for easy differentiation
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 331
- Forks
- 56
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 13
Description
Example: https://docs.openfree.energy/en/latest/tutorials/index.html
In the tutorial page we use different heading levels to put the tutorials into categories. Unfortunately it's very hard to see the difference between a top level heading and a low level one.
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 tutorial page at https://docs.openfree.energy/en/latest/tutorials/index.html and inspect how its heading levels are rendered. Identify the documentation styling responsible for the weak distinction and make the heading hierarchy visually easier to scan; the page should clearly differentiate top-level and lower-level headings when done.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100