Skip to content

docs(documentation): name guide files by prefix and number (v3.29.2) - #73

Merged
cheneeheng merged 2 commits into
mainfrom
docs/guide-file-naming-convention
Aug 11, 2026
Merged

docs(documentation): name guide files by prefix and number (v3.29.2)#73
cheneeheng merged 2 commits into
mainfrom
docs/guide-file-naming-convention

Conversation

@cheneeheng

Copy link
Copy Markdown
Owner

What

Gives ceh-documentation:user-operator-guide a file-naming convention for the multi-file guide
trees it produces, and releases it as v3.29.2.

  • Root-level files under docs/guide/ keep plain names — no prefix, no number.
  • Every subfolder file becomes <PREFIX>-<NN>-<name>.md: a capitalized abbreviation of the
    subfolder (at least 2 chars, 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; one file goes back to the root level, and a root-level
    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 than
a 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.md and in DECISION_LOG.md entries 73–74:

  • Numbers stay contiguous. The number is reading order, not an ID. Appending a guide at the
    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.
  • The scheme beats the docs system. Docusaurus/MkDocs/mdBook derive nav order from filenames
    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 records
    the 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-documentation 1.1.4 → 1.1.5 in both manifests; CHANGELOG 3.29.2.

Testing

  • python tools/validate-plugins/validate.pyOK: all plugin checks passed
  • python ceh-documentation/scripts/check-semver.py CHANGELOG.mdOK: All version entries are valid semver

Docs-only change; no runtime code paths touched.

Checklist

  • Root README needs no change — its row describes the skill's triggers, not its output layout
  • ceh-documentation/README.md updated
  • CROSS_REFERENCES.md checked — this block is not duplicated anywhere
  • Version bumped in plugin.json and marketplace.json in the same commit as the content
  • Validator green

Generated with Claude Code by CEH

`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
@cheneeheng
cheneeheng merged commit 238f451 into main Aug 11, 2026
1 check passed
@cheneeheng
cheneeheng deleted the docs/guide-file-naming-convention branch August 11, 2026 16:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant