Page MenuHomePhabricator

docs: Rearchitect Codex usage and contributing guidelines
Closed, ResolvedPublic

Description

Background

The current usage and contribution guidelines need to be reviewed and updated to improve clarity and structure for future Codex users and contributors. The goal is to make the content easier to read, better summarized, and more actionable.

Acceptance criteria (or Done)

  • Site architecture is streamlined
  • Usage guidelines are consolidated, updated, and easier to navigate
  • Contributing guidelines are consolidated, updated, and easier to navigate
  • Clear points of contact are provided for both internal and external contributors to address questions and requests

Event Timeline

CCiufo-WMF triaged this task as Medium priority.May 12 2025, 3:51 PM

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

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

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

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

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

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

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

[design/codex@main] docs: Re-architect usage and contirbuting sections

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

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

[design/codex@main] docs: Update and simplify developer contribution docs

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

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

[design/codex@main] docs: Update and improve icon documentation

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

AnneT renamed this task from docs: Update Design Contribution Guidelines to docs: Rearchitect Codex usage and contributing guidelines.May 29 2025, 4:15 PM
AnneT changed the task status from Open to In Progress.
AnneT updated the task description. (Show Details)

Change #1152336 had a related patch set uploaded (by Dtorsani; author: Dtorsani):

[design/codex@main] docs: Update various docs pages part 1

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

Change #1152867 had a related patch set uploaded (by Dtorsani; author: Dtorsani):

[design/codex@main] docs: Update various docs pages part 2

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

Change #1146974 merged by jenkins-bot:

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

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

Change #1147781 merged by jenkins-bot:

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

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

Change #1151384 merged by jenkins-bot:

[design/codex@main] docs: Re-architect usage and contributing sections

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

Change #1152867 merged by jenkins-bot:

[design/codex@main] docs: Update various docs pages part 2

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

Change #1152091 merged by jenkins-bot:

[design/codex@main] docs: Update and simplify developer contribution docs

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

Change #1152092 merged by jenkins-bot:

[design/codex@main] docs: Update and improve icon documentation

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

Change #1152336 merged by jenkins-bot:

[design/codex@main] docs: Update various docs pages part 1

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

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

[design/codex@main] docs: remove unused files

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

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

[design/codex@main] docs: Clean up recent changes

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

Change #1155224 merged by jenkins-bot:

[design/codex@main] docs: remove unused files

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

Following up on this discussion to remove unused documentation files, this patch (https://gerrit.wikimedia.org/r/1155224) removes unused doc pages:

  • /contributing/designing-new-components
  • /contributing/redesigning-existing-components

The links to the pages have already been removed (https://gerrit.wikimedia.org/r/q/1152091), and their content has been incorporated into the /contributing/designing-components documentation page (https://gerrit.wikimedia.org/r/q/1152867).

Change #1155232 merged by jenkins-bot:

[design/codex@main] docs: Clean up recent changes

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

Change #1155734 had a related patch set uploaded (by Bernard Wang; author: Bernard Wang):

[mediawiki/core@master] Update Codex from v2.0.0 to v2.1.0

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

Test wiki created on Patch demo by BWang (WMF) using patch(es) linked to this task:
https://patchdemo.wmcloud.org/wikis/25f905bb47/w/

Change #1155734 merged by jenkins-bot:

[mediawiki/core@master] Update Codex from v2.0.0 to v2.1.0

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