Skip to content

docs: link the file references the docs cite - #181

Merged
fbuireu merged 4 commits into
mainfrom
docs/link-doc-references
Aug 23, 2026
Merged

docs: link the file references the docs cite#181
fbuireu merged 4 commits into
mainfrom
docs/link-doc-references

Conversation

@fbuireu

@fbuireu fbuireu commented Aug 23, 2026

Copy link
Copy Markdown
Owner

Description

Every document that names a file in prose or in a table now points at it. The first mention of a given file in a document becomes a link; later mentions stay plain, so a paragraph does not turn into a list of links. 254 links across 39 markdown files, no prose rewritten and no source touched.

Type of Change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📝 Documentation update
  • 🔧 Configuration change
  • ♻️ Code refactoring
  • ⚡ Performance improvement
  • ✅ Test update

Related Issue

Changes Made

  • The first mention of a file in each document is now a link, with the backticks kept inside the link text: [`tracker.ts`](./tracker.ts). This covers ARCHITECTURE.md, the root guide, CONTRIBUTING.md, the PR template, every ADR, all eight layer guides and the wiki pages.
  • Pages under docs/wiki/ link through https://github.com/fbuireu/github-star-tracker/blob/main/… rather than a relative path. sync-wiki.yml publishes that folder to the GitHub Wiki, where a path into the repository does not resolve — it is the form those pages already used for CONTRIBUTING.md, the ADRs and the examples gallery.
  • A name several files share is linked only where the line itself says which one it means. `index.ts` as the entry point, types.ts as "one per concept", the layer's CLAUDE.md`` and the like name a kind of file rather than one file, and keep their plain backticks.
  • Nothing inside code fences, headings or HTML tags was touched — the README's logo and chart references sit in '<img src="…">' and are unchanged — and nothing that points outside the repository was given a target: stars-data.json, stargazers.json and charts/*.svg live on the data branch, and star-tracker.yml lives in the consumer's repository.

Testing

  • Existing tests pass (pnpm test) — pnpm test:docs, 48 passed
  • Added new tests for changes
  • Manually tested with sample workflow
  • Verified action builds successfully (pnpm build)
  • Attached the rendered output (report, badge or chart) if this PR changes what gets rendered

Nothing under src/ changed, so dist/ is untouched and there is no rendered output to attach.

Checklist

  • My code follows the style guidelines of this project (pnpm check)
  • I have performed a self-review of my own code
  • I rebuilt dist/ with pnpm build and committed it, if I touched anything under src/ — not applicable, no source changed
  • I updated the relevant section of any CLAUDE.md my change affects
  • Changed inputs, outputs or defaults are reflected in action.yml, the wiki and the README — not applicable, none changed
  • New or redefined domain vocabulary is in CONTEXT.md; a hard-to-reverse decision has an ADR — not applicable, no new vocabulary or decision
  • docs/docs-consistency.test.ts passes, so the docs and the code still agree
  • My changes generate no new warnings or errors
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published

Additional Notes

Two things worth a reviewer's eye:

  • Paragraphs that gained a link now run past the ~110-column wrap of the surrounding prose. Reflowing them would have buried the change in whitespace noise, so the lines are left long. Say the word and they get rewrapped.
  • The wiki pages are the one place where the link form differs from the rest of the repository, for the reason above; if a page is ever read from the repository rather than the Wiki, those links still work, they just leave the tree.

GIF (mandatory)

Thanks for contributing!


Generated by Claude Code

claude added 2 commits August 23, 2026 08:54
Every document that names a file in prose or in a table now points at it. The
first mention of a given file in a document becomes a link; later mentions stay
plain, so a paragraph does not turn into a list of links.

Pages under docs/wiki are published to the GitHub Wiki, where a relative path
into the repository does not resolve, so those link through
github.com/fbuireu/github-star-tracker/blob/main as the pages already did.

References inside code fences, headings and HTML tags are left alone, as are
mentions that name a kind of file rather than one file — "the layer's
CLAUDE.md".
A name that several files share is linked only where the sentence itself says
which one it means — a folder named in the same table row, or a sibling
already linked beside it. The mentions that name a kind of file rather than
one file keep their plain backticks.
@codecov

codecov Bot commented Aug 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

claude added 2 commits August 23, 2026 09:25
# Conflicts:
#	ARCHITECTURE.md
#	CONTRIBUTING.md
#	docs/adr/0003-commit-the-bundled-dist-directory.md
The em-dash rewrite on main and this branch touched the same sentences in
ARCHITECTURE.md, CONTRIBUTING.md and ADR 0003. The merge kept main's wording,
so the links it dropped are applied again on top of it.
@fbuireu
fbuireu merged commit c0725e7 into main Aug 23, 2026
7 checks passed
@fbuireu
fbuireu deleted the docs/link-doc-references branch August 23, 2026 09:26
@fbuireu

fbuireu commented Aug 23, 2026

Copy link
Copy Markdown
Owner Author

🎉 This PR is included in version 1.26.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants