Documentation page structure - familliar patterns

[cyberschnaps]

Issue description
Not all documentation pages have the same basic structure for subnavigation.

Why does it matter?
It impacts usability. It's a quick-win with a strong impact. It is a well know UX fact that familiar design patterns help improve discoverability, usability and overall navigation (Hicks, Jakobs, Law of Common Region, Law of Uniform Connectedness).

Context
The existing recurrent patterns we have in the documentation now are the following:

• Understand the Basics
• Configuration
• Examples

Sources: Settings,

However some pages are mixing other elements at the same level of subnavigation, for example the Components page has:

• Understand the Basics
• How to find it?
• Manage components
• Actions

Other discrepancies include: Participatory processes, Conferences, Comments, and many more...

Proposal
Create a unified structure for subnavigation which is always applied. All other sections should become sub-sections. Example:

• Understand the Basics (works fine)
• • How to find it
• • perhaps something else (this section should be kept short)
• Configuration (or Options? which has a more permissive meaning)
• • Actions
• • Manage X
• • Create Y
• Examples (works fine)

[paulinebessoles]

Hi @cyberschnaps, thank you for your feedback!

Indeed, all pages should have the same structure, and I like the one you're proposing!

@NilHomedes @carolromero @andreslucena what do you think?

[carolromero]

Hi there! @cyberschnaps' suggestion sounds good to me, so +1 to follow the same structure.

[froger]

Thanks @cyberschnaps ! I have a question of clarification, I did understand your proposal as a set of rules:

• first level of navigation is always: Understand the Basics, Configuration, Examples
• second level of navigation can be whatever
• no other levels allowed (like a third level as https://docs.decidim.org/en/develop/admin/features/transparency/statistics)

Is that right?

[cyberschnaps]

@froger thanks. Exactly, at least for the Admin documentation.

Can you please specify what is the third level you are mentionning on this page https://docs.decidim.org/en/develop/admin/features/transparency/statistics ? I only see 2 levels.

[froger]

@cyberschnaps haha thanks, I did understand wrongly what you mean by subnavigation.
So for example here:
https://docs.decidim.org/en/develop/admin/global_moderations

[cyberschnaps]

@froger exactly, thank you for clarifying. I understand you don't have any more questions or feedbacks.

[paulinebessoles]

I was also thinking that we should document the contribution rules to the documentation (page structure, language guidelines, neutral, etc.)