Page MenuHomePhabricator

Codex components pages: improve titles within Guidelines
Closed, ResolvedPublic2 Estimated Story Points

Description

Background

Based on the results of T363513: Test the Codex components pages with internal users and analyze the results, we will need to improve the titles in the Guidelines section in the components pages to improve the scannability of the components guidelines. So we need to:

  • Consider renaming the "Using" section for clarity to something like "When to use".
  • Improve the findability of min-max limitations by including a title like "Component limitations" for easier scanning.

Decided names

  • When to use name-of-the-component (e.g. When to use accordions)
  • Component limitations: this will be included as subsection in the "Specifications" section

Acceptance criteria (or Done)

  • Decide the best names for these sections
  • Update components pages with these new titles

Event Timeline

bmartinezcalvo moved this task from Inbox to Up Next on the Design-System-Team board.
bmartinezcalvo updated the task description. (Show Details)
Catrope set the point value for this task to 2.May 13 2024, 6:09 PM

Change #1031518 had a related patch set uploaded (by Bmartinezcalvo; author: Bmartinezcalvo):

[design/codex@main] docs: improve titles within components guidelines

https://gerrit.wikimedia.org/r/1031518

I've created this patch improving the following titles within the components guidelines in Codex:

  • I've rephrased the "Using" section to "When to use". Since the new title aligns better with the content, it improves its navigation.
  • I've included a new subtitle within the "Specifications" section to explain the "Component limitations"

Captura de pantalla 2024-05-14 a las 19.14.38.png (1×1 px, 311 KB)

You can check these changes in the Accordion, Button, and ButtonGroup components. If you all agree with these new titles I can apply them to all components pages.

This proposal seems fine to me. Thanks for working on this.

I'm not fully on page yet. Two questions/inputs:

  1. Wouldn't we do this consistently for all documentation pages? We have these titles across all components and on overview pages like components, icons, design tokens. Guessing that was the plan, but the patch is not flagged as 'work in progress' and we could end up currently with only a few pages changed, instead of all at once.
  2. Given our current documentation page layout, I think it's a really good idea to repeat the title again. It provides a mental anchor point for the readers switching through a number of our documentation. So for example instead of “When to use” “When to use Tables”.
  1. Given our current documentation page layout, I think it's a really good idea to repeat the title again. It provides a mental anchor point for the readers switching through a number of our documentation. So for example instead of “When to use” “When to use Tables”.

+1, I think that would be a good addition.

Volker_E changed the task status from Open to In Progress.Thu, May 16, 5:08 AM
El T364762#9796801, @Volker_E escribió:

I'm not fully on page yet. Two questions/inputs:

  1. Wouldn't we do this consistently for all documentation pages? We have these titles across all components and on overview pages like components, icons, design tokens. Guessing that was the plan, but the patch is not flagged as 'work in progress' and we could end up currently with only a few pages changed, instead of all at once.

@Volker_E oh yes, sorry, I was going to update all the components pages with these new names in the same patch. I just submitted the patch with the first 3 components to check if these new titles were ok.

  1. Given our current documentation page layout, I think it's a really good idea to repeat the title again. It provides a mental anchor point for the readers switching through a number of our documentation. So for example instead of “When to use” “When to use Tables”.

Great, I will do. Thank you!

Change #1031518 merged by jenkins-bot:

[design/codex@main] docs: improve titles within components guidelines

https://gerrit.wikimedia.org/r/1031518

Patch got merged.
For visibility, there's now an inconsistency with “Using links and buttons” page title including the navigation. If folks have flagged this elsewhere, I challenge why it would remain in this case. cc: @DTorsani-WMF

Change #1034517 had a related patch set uploaded (by Bmartinezcalvo; author: Bmartinezcalvo):

[design/codex@main] docs: update info in the design contribution guidelines

https://gerrit.wikimedia.org/r/1034517

Change #1034517 merged by jenkins-bot:

[design/codex@main] docs: update info in the design contribution guidelines

https://gerrit.wikimedia.org/r/1034517

Change #1037103 had a related patch set uploaded (by Anne Tomasevich; author: Anne Tomasevich):

[mediawiki/core@master] Update Codex from v1.6.0 to v1.6.1

https://gerrit.wikimedia.org/r/1037103

Test wiki created on Patch demo by ATomasevich (WMF) using patch(es) linked to this task:
https://patchdemo.wmflabs.org/wikis/ce0a74a0e6/w

Change #1037103 merged by jenkins-bot:

[mediawiki/core@master] Update Codex from v1.6.0 to v1.6.1

https://gerrit.wikimedia.org/r/1037103

Test wiki on Patch demo by ATomasevich (WMF) using patch(es) linked to this task was deleted:

https://patchdemo.wmflabs.org/wikis/ce0a74a0e6/w/