Page MenuHomePhabricator
Create Task
Maniphest T301730

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

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.

Details

Related Changes in Gerrit:
SubjectRepoBranchLines +/-
Update Codex from v1.0.1 to v1.1.1mediawiki/coremaster+2 K -1 K
docs: Update readme files to reference usage docsdesign/codexmain+86 -121
Customize query in gerrit

Related Objects

Event Timeline

Catrope created this task.Feb 14 2022, 9:48 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptFeb 14 2022, 9:48 PM
Volker_E added a project: Documentation.Feb 14 2022, 9:49 PM
egardner moved this task from Incoming/Requests to Ready for development on the Design-Systems-team-20200324-20220422 (Design Systems Team FY2021-22 Kanban Board) board.Feb 15 2022, 10:43 PM
egardner moved this task from Backlog to Contributor Experience on the Codex board.Feb 15 2022, 11:11 PM
ldelench_wmf moved this task from Contributor Experience to Backlog on the Codex board.Apr 22 2022, 8:53 PM
AnneT edited projects, added Design-System-Team; removed Design-Systems-team-20200324-20220422 (Design Systems Team FY2021-22 Kanban Board).Aug 3 2022, 4:12 PM
AnneT mentioned this in T315588: [EPIC] Make it easier to use Codex, improve designer and developer experience.Aug 18 2022, 5:20 PM
ldelench_wmf added a parent task: T315588: [EPIC] Make it easier to use Codex, improve designer and developer experience.Sep 15 2022, 5:51 PM
ldelench_wmf triaged this task as Medium priority.Sep 15 2022, 5:54 PM
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
ldelench_wmf moved this task from Inbox to Backlog on the Design-System-Team board.Jan 20 2023, 7:09 PM
ldelench_wmf removed a parent task: T315588: [EPIC] Make it easier to use Codex, improve designer and developer experience.Feb 17 2023, 11:48 PM
ldelench_wmf moved this task from Backlog to Codex Adoption on the Codex board.
tyhopp mentioned this in T350651: docs: Clarify required packages when installing.Nov 7 2023, 4:56 AM
tyhopp subscribed.Nov 7 2023, 5:09 AM
tyhopp mentioned this in T349859: docs: Document how to include Codex CSS when using Codex via npm.Nov 7 2023, 8:48 AM
tyhopp claimed this task.Nov 9 2023, 2:20 AM
gerritbot added a comment.Nov 12 2023, 2:10 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

gerritbot added a project: Patch-For-Review.Nov 12 2023, 2:10 PM
gerritbot added a comment.Nov 27 2023, 11:18 PM

Change 973405 merged by jenkins-bot:

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

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

Maintenance_bot removed a project: Patch-For-Review.Nov 27 2023, 11:30 PM
gerritbot added a comment.Dec 6 2023, 4:26 PM

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

gerritbot added a project: Patch-For-Review.Dec 6 2023, 4:26 PM
PatchDemoBot added a comment.Dec 6 2023, 4:35 PM

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

gerritbot added a comment.Dec 6 2023, 5:18 PM

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

Maintenance_bot removed a project: Patch-For-Review.Dec 6 2023, 5:32 PM
AnneT closed this task as Resolved.Dec 6 2023, 5:32 PM
PatchDemoBot added a comment.Apr 23 2024, 4:33 PM

Test wiki on Patch demo by ATomasevich (WMF) using patch(es) linked to this task was deleted:

https://patchdemo.wmflabs.org/wikis/d419984345/w/

Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits