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

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.

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>
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