Skip to content

docs: fix stale long-form doc paths after the plugin-rename reorg#80

Open
taminomara wants to merge 1 commit into
testdouble:mainfrom
taminomara:docs/fix-stale-skill-doc-paths
Open

docs: fix stale long-form doc paths after the plugin-rename reorg#80
taminomara wants to merge 1 commit into
testdouble:mainfrom
taminomara:docs/fix-stale-skill-doc-paths

Conversation

@taminomara

Copy link
Copy Markdown
Contributor

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}/ and docs/agents/han-core/ layout.

  • Documentation-only change across four files: the PR template, CONTRIBUTING.md, CLAUDE.md, and the coverage-rule template. No skill, agent, or runtime behavior is touched.
  • Fixes one genuinely broken link (the /update-pr-description doc URL in the PR template, which 404'd) and updates the convention path patterns in prose from the flat docs/skills/{name}.md form to the nested {plugin}/han-core form.
  • The bulk of the diff (the CLAUDE.md skill catalog) is cosmetic: the link hrefs already pointed at the correct nested files, so only the visible label text was realigned to match.
  • Historical records (CHANGELOG.md, docs/plans/, docs/research/) were deliberately left with their period-accurate flat paths.

What to look at first

  • The one functional fix worth confirming is the PR template URL change, which is the only previously-broken (404ing) link in the set.
  • Decide whether you agree with the line drawn on what to update: live convention docs were corrected, but historical records keep their old flat paths on purpose. If you think the CHANGELOG or plan/research docs should also be swept, flag it.
  • The large CLAUDE.md block 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-description 404), 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.

@mxriverlynn

Copy link
Copy Markdown
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 main branch into your branch, and resolve the conflicts? i'll get this merged as soon as i can, after that.

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>
@taminomara taminomara force-pushed the docs/fix-stale-skill-doc-paths branch from 6e7d52a to 6308338 Compare June 18, 2026 21:41
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.

2 participants