Page MenuHomePhabricator

docs: Document all our contribution flows
Open, LowestPublic

Description

Background/Goal

We need to document all our contribution flows (both for design and development flows) and update them in the Codex demo.

User stories

As a designer I need to know:

  • How to create new components
  • How to update existing components
  • How to create tokens
  • How to create new icons

As a developer I need to know:

  • How to implement new components
  • How to update and create new features for existing components
  • How to implement tokens in the system
  • How to include icons in the system

Acceptance criteria (or Done)

The following processes must be documented in Codex:

Contributing design
Contributing code
  • Components
    • Component addition process T304423
    • Updating existing components T312029
  • Adding new icons
  • Tokens
    • Adding new tokens in the code
    • Updating exitsting tokens

Event Timeline

Designing new tokens or updating existing tokens is another needed point. These two resources need to be intertwined with current overview https://doc.wikimedia.org/codex/main/design-tokens/overview.html
Which from information architecture perspective is a bit confusing now, as we talk about Designing all those parts of Codex above, but explain what tokens are much further below.

Designing new tokens or updating existing tokens is another needed point. These two resources need to be intertwined with current overview https://doc.wikimedia.org/codex/main/design-tokens/overview.html
Which from information architecture perspective is a bit confusing now, as we talk about Designing all those parts of Codex above, but explain what tokens are much further below.

@Volker_E thank you for flagging this. Added them as acceptance criteria of the task (both for design and code collaborations) and feel free to add items in the task checklist if needed.

@Volker_E Is there any documentation in Codex on how to implement new tokens and update existing ones?

bmartinezcalvo renamed this task from Document all our contribution flows to docs: Document all our contribution flows.Mar 13 2025, 1:11 PM
bmartinezcalvo removed a subscriber: Sarai-WMDE.
bmartinezcalvo removed a subscriber: DAbad.