Components Guidelines: Include the rest of the Figma specs info in Codex
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	bmartinezcalvo
	Feb 15 2024, 6:31 PM

Description

Background goal

Since just the MVP version of the Components Guidelines were included in Codex, there are some misalignments between these Guidelines in Codex and the components specs in Figma since the following sections from the Figma specs are missing in Codex:

Use cases (Do - Don't) explaining the best practices for the component
Minimum and maximum examples: explaining how the component behaves with short and long content
Keyboard navigation: explaining all the shortcuts to navigate the component with the keyboard

The Codex site should be the source of truth of our Design System, so we need all these info there.

User stories

As a Codex user (designer, developer, or other) I need to know all the information about a component when navigating the component's page.

Open questions

Acceptance criteria (or Done)

Future tasks

T355419: Codex Figma library: Evaluate the documentation in the spec sheets

Details

	Subject	Repo	Branch	Lines +/-
	Update Codex from 1.3.6 to 1.4.0	mediawiki/core	master	+190 -114
	docs: Update image in the InfoChip best practices	design/codex	main	+12 -17

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Open	None	T349016 docs: Improvements to content of component guidelines
Resolved	bmartinezcalvo	T357714 Components Guidelines: Include the rest of the Figma specs info in Codex
Resolved	bmartinezcalvo	T358859 Figma content to Codex: Document the Guidelines for Min-Max and Best Practices
Resolved	bmartinezcalvo	T358860 Figma content to Codex: Implement new Guidelines in Codex
Resolved	bmartinezcalvo	T358861 Figma content to Codex: include Keyboard Navigation in Codex

Event Timeline

bmartinezcalvo created this task.Feb 15 2024, 6:31 PM

bmartinezcalvo updated the task description. (Show Details)

bmartinezcalvo renamed this task from Include the rest of Figma specs info in Guidelines in Codex to Components Guidelines: Include the rest of the Figma specs info in Codex.Feb 15 2024, 6:34 PM

bmartinezcalvo updated the task description. (Show Details)

bmartinezcalvo moved this task from Inbox to Backlog on the Design-System-Team board.

bmartinezcalvo mentioned this in T349016: docs: Improvements to content of component guidelines.Feb 15 2024, 6:37 PM

bmartinezcalvo mentioned this in T355415: Components Guidelines: Explore solutions to make its images easier to maintain.

bmartinezcalvo updated the task description. (Show Details)Feb 15 2024, 6:40 PM

CCiufo-WMF mentioned this in T355419: Codex Figma library: Evaluate the documentation in the spec sheets.Feb 26 2024, 5:10 PM

CCiufo-WMF mentioned this in T358027: Components Guidelines: test Figma embeds in one component's page.

bmartinezcalvo mentioned this in T357701: Explore improvements to the navigation of the components pages in Codex.Mar 1 2024, 11:52 AM

bmartinezcalvo updated the task description. (Show Details)Mar 1 2024, 12:52 PM

bmartinezcalvo closed subtask T358859: Figma content to Codex: Document the Guidelines for Min-Max and Best Practices as Resolved.Mar 18 2024, 2:50 PM

bmartinezcalvo mentioned this in T361115: Design Contribution documentation: Update the "Guidelines" section.Mar 27 2024, 3:10 PM

bmartinezcalvo updated the task description. (Show Details)Thu, Apr 4, 9:26 AM