Page MenuHomePhabricator

Make README.md files NPM-appropriate
Closed, ResolvedPublic1 Estimated Story Points

Description

Currently the README.md files in each of the packages assume the greater context of the Codex repository. Instead, they should be much more self-contained, because they're going to be the descriptions that people read on NPM.

Event Timeline

ldelench_wmf set the point value for this task to 1.Sep 19 2022, 3:42 PM
ldelench_wmf lowered the priority of this task from Medium to Lowest.Jan 20 2023, 7:06 PM

Change 973405 had a related patch set uploaded (by Tyhopp; author: Tyhopp):

[design/codex@main] docs: Update readme files to reference usage docs

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

Change 973405 merged by jenkins-bot:

[design/codex@main] docs: Update readme files to reference usage docs

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

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

[mediawiki/core@master] Update Codex from v1.0.1 to v1.1.1

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

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

Change 980902 merged by jenkins-bot:

[mediawiki/core@master] Update Codex from v1.0.1 to v1.1.1

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