Charmed Ceph: Stylistic inconsistencies in the how-to index
#280 ouverte le 13 août 2025
Métriques du dépôt
- Stars
- (119 étoiles)
- Métriques de merge PR
- (Métriques PR en attente)
Description
[! IMPORTANT] Notice that this task contains a
workshoplabel; this means that it has been created for the live DjangoCon/Ubucon 2025 Open Documentation Academy workshop to assist community members make their first documentation contribution. Please, do not work on this task unless it is assigned to you.
Background
The Charmed Documentation how-to index lacks stylistic uniformity. Only some subsections appear in bold; this formatting is applied inconsistently, as carets appear in both bold and plain-font subheadings.
The lack of uniform structuring violates the principles of clear and consistent labelling and structured, scannable formatting. This decreases the functional quality of the work. In the case of the index, the cognitive load is clearly increased, as the user will be drawn to the bold content first, assuming it has a higher hierarchy, and will need to look further if the subsection they are interested in is in plain-font format.
Task
Apply the bold font for only the highest hierarchy level (H1 level) to ensure consistency and make it easier to find the main sections when the user expands the index.
Resources
- Charmed Ceph docs
- Follow our documentation contributing guide
- especially how to edit docs on Discourse
- Read the Ubuntu Code of Conduct.
- Visit the academy website to learn more
Thank you in advance for your contribution!