docs(documentation): name guide files by prefix and number (v3.29.2) - #73
Merged
Conversation
`user-operator-guide` told an agent to build a cross-linked tree under `docs/guide/` and then said nothing about what to call the files in it. Reading order existed only inside `index.md`; sorting a subfolder taught you the alphabet, not the sequence. Root-level files keep plain names. Every subfolder file becomes `<PREFIX>-<NN>-<name>.md` — a capitalized abbreviation of the subfolder, at least two characters and unique across the tree, then a two-digit number restarting at 01 in each subfolder. A nested folder chains its parent prefix (`operations/database/` -> `OP-DB-01-backup.md`). A subfolder holds at least two files. Two choices carry their reasoning in the plugin README because they are the kind that get quietly reversed. Numbers stay contiguous: the number is reading order, not an ID, so an insert or delete renumbers the subfolder and updates every link in the same pass (appending renumbers nothing). And the scheme beats the docs system: Docusaurus/MkDocs derive nav from filenames, so nav order goes in frontmatter, never in a rename. Bumps `ceh-documentation` 1.1.4 -> 1.1.5 in plugin.json and marketplace.json. DECISION_LOG entries 73-74 record the docs-system precedence call and its reversal. Generated with [Claude Code](https://claude.com/claude-code) by CEH
Ships a file-naming convention for the multi-file guides `user-operator-guide` produces: root-level pages keep plain names, subfolder pages become `<PREFIX>-<NN>-<name>.md`, numbered contiguously from 01 per subfolder so the filename carries reading order. - Bump: PATCH — content-only change to an existing skill, no new skill or agent - Manifests: ceh-documentation 1.1.4 -> 1.1.5 (plugin.json + marketplace.json) - Docs: CHANGELOG 3.29.2 added; ceh-documentation README documents the two reversible choices; root README needs no update (its row describes triggers, not output layout); CLAUDE.md unchanged — no project fact or structure moved Generated with [Claude Code](https://claude.com/claude-code) by CEH
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.
What
Gives
ceh-documentation:user-operator-guidea file-naming convention for the multi-file guidetrees it produces, and releases it as v3.29.2.
docs/guide/keep plain names — no prefix, no number.<PREFIX>-<NN>-<name>.md: a capitalized abbreviation of thesubfolder (at least 2 chars, unique across the tree), then a two-digit number restarting at
01in each subfolder.
operations/database/→OP-DB-01-backup.md.topic that grows to two moves down into a subfolder.
Why
The skill told an agent to build a cross-linked tree under
docs/guide/for anything broader thana single topic, then said nothing about naming the files in it. The example tree used plain names,
so every guide invented its own layout and the order a reader should follow the pages in existed
only inside
index.md— sorting a subfolder taught you the alphabet, not the sequence.How
Two choices in the scheme are the kind that get quietly reversed later, so both carry their
reasoning in
ceh-documentation/README.mdand inDECISION_LOG.mdentries 73–74:end renumbers nothing; an insert or delete renumbers the rest of that subfolder and updates every
link to a renamed file in the same pass. Append-only-with-gaps was rejected — it demotes the
number to an arbitrary ID, at which point numbering earns nothing. It only wins if these
filenames ever get referenced from outside the repo.
and would compete with the prefix. Nav order and page metadata go in frontmatter
(
sidebar_position,title) instead. Entry 73 originally decided the opposite; entry 74 recordsthe reversal and why (no docs-site framework is in use here).
Touched: Phase 3 (new How to name the files section + rewritten example tree), Phase 5 (two
checklist items), Output.
ceh-documentation1.1.4 → 1.1.5 in both manifests; CHANGELOG 3.29.2.Testing
python tools/validate-plugins/validate.py→OK: all plugin checks passedpython ceh-documentation/scripts/check-semver.py CHANGELOG.md→OK: All version entries are valid semverDocs-only change; no runtime code paths touched.
Checklist
ceh-documentation/README.mdupdatedCROSS_REFERENCES.mdchecked — this block is not duplicated anywhereplugin.jsonandmarketplace.jsonin the same commit as the contentGenerated with Claude Code by CEH