docs: fix stale long-form doc paths after the plugin-rename reorg#80
Open
taminomara wants to merge 1 commit into
Open
docs: fix stale long-form doc paths after the plugin-rename reorg#80taminomara wants to merge 1 commit into
taminomara wants to merge 1 commit into
Conversation
Collaborator
|
@taminomara i just realized the work i've been doing today caused conflicts with this PR - but i still want to get this PR merged in! i appreciate the effort a lot, and want to make sure your name is still attached to the commits. can you pull in the latest |
mxriverlynn
added a commit
that referenced
this pull request
Jun 18, 2026
#81) ## Summary **This PR updates the contributor PR-template checklist to stop chasing entity counts that no longer exist, so that the template matches the "indexes stay complete, not counted" convention.** - Rewrites the index-maintenance checklist item: instead of telling contributors to update a count line in `CLAUDE.md` plus hardcoded counts in `docs/concepts.md` and `README.md`, it now asks them to confirm the two indexes, the `CLAUDE.md` catalog, and `docs/concepts.md` each list every current skill and agent. - Drops "counts" from the list of things `/han-update-documentation` syncs, since there are no longer any counts to sync. - Scope is two lines in one file. Pure process/documentation text, with no skill, agent, or runtime behavior change. - Follow-up to a triage that flagged this drift; the adjacent path-fix branch (PR #80) deliberately left this count-convention drift out of its scope. ## What to look at first - The replacement checklist item (line 20): does it correctly name the four places that must each list every entity, and does the instruction read clearly to a contributor who has never seen the convention? It states the rule prospectively, with no reference to the old count-based wording (that history lives in the commit message, not the checklist). - Whether the targets it points at are real: the old line referenced a "Counts to verify when editing indexes" line in `CLAUDE.md` and counts in `docs/concepts.md` and `README.md` that have already been removed. Worth a quick confirm that the new wording does not point anyone back at a count that no longer lives in those files. - The `/han-update-documentation` paragraph (line 26): removing "counts" should leave the sentence accurate about what that skill still syncs (long-form docs, indexes, cross-references) and not imply it dropped real work. ## Files of interest - `.github/pull_request_template.md` — the only file changed; two checklist lines realigned to the count-free index convention.
The plugin dot->hyphen reorg nested long-form docs under
docs/skills/{plugin}/ and docs/agents/han-core/ but left flat {name}.md
references behind:
- .github/pull_request_template.md: the /update-pr-description doc link
404'd (docs/skills/update-pr-description.md -> .../han-github/...), and
its coverage-rule path pattern was flat.
- docs/templates/coverage-rule.md, CONTRIBUTING.md, CLAUDE.md: the same
flat docs/skills/{name}.md / docs/agents/{name}.md convention prose.
- CLAUDE.md: the doc-map skill catalog listed flat docs/skills/{name}.md
link labels even though their hrefs already pointed at the nested
docs/skills/{plugin}/{name}.md files; the labels now match the hrefs.
Updates the convention paths to docs/skills/{plugin}/{name}.md and
docs/agents/han-core/{name}.md. Historical records (CHANGELOG.md,
docs/plans, docs/research) are left untouched.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
6e7d52a to
6308338
Compare
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.
Summary
This PR rewrites stale long-form doc references that survived the dotted-to-hyphenated plugin rename, so links resolve and label text matches the nested
docs/skills/{plugin}/anddocs/agents/han-core/layout.CONTRIBUTING.md,CLAUDE.md, and the coverage-rule template. No skill, agent, or runtime behavior is touched./update-pr-descriptiondoc URL in the PR template, which 404'd) and updates the convention path patterns in prose from the flatdocs/skills/{name}.mdform to the nested{plugin}/han-coreform.CLAUDE.mdskill catalog) is cosmetic: the link hrefs already pointed at the correct nested files, so only the visible label text was realigned to match.CHANGELOG.md,docs/plans/,docs/research/) were deliberately left with their period-accurate flat paths.What to look at first
CLAUDE.mdblock is label-text-only alignment, not link repair. It is safe to skim once you confirm the hrefs were already correct.Files of interest
.github/pull_request_template.md— contains the only previously-broken link (the/update-pr-description404), plus a coverage-rule path pattern in the checklist.CLAUDE.md— the largest diff (~34 lines), but cosmetic label-text realignment in the skill catalog.docs/templates/coverage-rule.md— the canonical statement of the doc-path convention, updated to the nested form.CONTRIBUTING.md— convention path patterns in contributor prose, updated to match.