Page MenuHomePhabricator

Table: Design and build the demo page
Closed, ResolvedPublic3 Estimated Story Points

Description

Background

Table is a complex component that will cover a wide variety of use cases, all of which should be documented in our platform to support Codex users.

Planning the structure and contents of this component's demo page will be essential to ensure that the potentially extensive design guidelines and demos remain as accessible as possible. It'll be key to simplify, prioritize the content, and avoid redundancies.

This task covers designing and building a demo page on the Codex docs site for the Table component.

Note that a series of demos is being created for the Table component in the sandbox, some of which may be repurposed for the docs site page.


Acceptance criteria

  • Make a list of all guidelines sections to include
  • Make a list of all necessary functionality to demonstrate
  • Transform that into a list of demos
  • Specify the content of each demo
  • Specify the content of each design guidelines section
  • Build the page

Event Timeline

Restricted Application added a subscriber: Aklapper. · View Herald Transcript
CCiufo-WMF triaged this task as Medium priority.Mar 14 2024, 3:01 PM
lwatson set the point value for this task to 3.Mar 18 2024, 5:45 PM
AnneT changed the task status from Open to In Progress.Apr 30 2024, 1:09 PM
AnneT claimed this task.

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

[design/codex@main] Table: Add demo page

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

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

[design/codex@main] Table: Add guidelines

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

Change #1026685 merged by jenkins-bot:

[design/codex@main] Table: Add demo page

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

Change #1029297 had a related patch set uploaded (by LWatson; author: LWatson):

[design/codex@main] Table: add scope to table headers

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

Change #1029297 merged by jenkins-bot:

[design/codex@main] demos: add `scope` to table headers in TableWithSlots example

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

Assigning to @Sarai-WMDE for design review! (The guidelines patch should merge today)

Change #1028837 merged by jenkins-bot:

[design/codex@main] Table: Add guidelines

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

Change #1030611 had a related patch set uploaded (by VolkerE; author: VolkerE):

[design/codex@main] docs: Amend guideline references and AT notes

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

Change #1030611 merged by jenkins-bot:

[design/codex@main] docs: Amend guideline references and AT notes

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

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

[design/codex@main] Table: Add reference to guidelines

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

Change #1030943 merged by jenkins-bot:

[design/codex@main] docs: Add reference to Table guidelines

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

Design verification done. All the planned guidelines and demo sections are represented (and even improved) in the Table's page. All acceptance criteria have been met 🎉

For documentation purposes, the following contents are missing yet planned:

  1. Link to the Table component in Figma: A link to Figma will be added in the "Specifications" section of the guidelines once the element is included in the Codex components design library.
  1. Empty table guidelines: Will be included at the end of the "Types" section once T364306: Table: Add empty state is completed.

@Sarai-WMDE awesome!!! Thanks so much for the excellent guidelines, and for providing a thorough review of everything!

Change #1032095 had a related patch set uploaded (by VolkerE; author: VolkerE):

[mediawiki/core@master] Update Codex from 1.5.0 to 1.6.0

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

Change #1032095 merged by jenkins-bot:

[mediawiki/core@master] Update Codex from 1.5.0 to 1.6.0

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