Repository navigation
Split per-command docs out of the README into /docs - #873
Merged
Merged
Conversation
The README had grown to 1,465 lines, almost all per-command reference, which buried the install and usage basics a first-time user needs. The reference now lives in five per-group files under /docs, keyed to the group field every command already declares, so the rule for documenting a new command is mechanical. The README keeps a compact per-group index table whose descriptions come from each command's desc export. Moving every section surfaced drift between docs and code, fixed here: 25 commands had no options list at all; add-tags and remove-tags were missing --status and --customFilter; remove-tags documented before/after date flags that do not exist; inline-media and find-replace lists were incomplete; export-comments was missing from the index entirely; and page-to-post was grouped under Members despite being a posts operation. AGENTS.md now includes the documentation step when registering a feature, and the missing Staff group, so the reference stays where it belongs instead of regrowing in the README.
|
Caution Review failedThe pull request is closed. Finishing Touches
Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of the repo-audit cleanup (docs step, second pass). The README was 1,465 lines of mostly per-command reference; it's now 151 lines, with the reference in five per-group files under
/docs.docs/tools.md(4),docs/content.md(30),docs/members.md(10),docs/staff.md(4),docs/beta.md(1) — grouped by each command's authoritativegroupfield, headings use command idsdescexport);export-commentsis now in the index (it was missing from the old TOC)add-tags/remove-tagswere missing--statusand--customFilter;remove-tagsdocumented nonexistent--before-date/--after-dateflags (dropped);inline-mediaandfind-replacelists completed from codecommands/page-to-post.js: groupMembers:→Content:(it's a posts operation)commands/comment-notifications.js: 'See the README' message now points at--helpStaff:group addedVerified mechanically: every one of the 49 command ids has exactly one heading across
/docs, exactly one README index row, and every link's file+anchor resolves.pnpm lintandpnpm test(271) pass.Note: external deep links into old README anchors can't be redirected; the index table keeps every command one click from the README top.