docs: link the file references the docs cite - #181
Merged
Conversation
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 Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
# 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.
Owner
Author
|
🎉 This PR is included in version 1.26.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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.
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
Related Issue
Changes Made
[`tracker.ts`](./tracker.ts). This coversARCHITECTURE.md, the root guide,CONTRIBUTING.md, the PR template, every ADR, all eight layer guides and the wiki pages.docs/wiki/link throughhttps://github.com/fbuireu/github-star-tracker/blob/main/…rather than a relative path.sync-wiki.ymlpublishes that folder to the GitHub Wiki, where a path into the repository does not resolve — it is the form those pages already used forCONTRIBUTING.md, the ADRs and the examples gallery.`index.ts`as the entry point,types.tsas "one per concept",the layer'sCLAUDE.md`` and the like name a kind of file rather than one file, and keep their plain backticks.'<img src="…">'and are unchanged — and nothing that points outside the repository was given a target:stars-data.json,stargazers.jsonandcharts/*.svglive on the data branch, andstar-tracker.ymllives in the consumer's repository.Testing
pnpm test) —pnpm test:docs, 48 passedpnpm build)Nothing under
src/changed, sodist/is untouched and there is no rendered output to attach.Checklist
pnpm check)dist/withpnpm buildand committed it, if I touched anything undersrc/— not applicable, no source changedCLAUDE.mdmy change affectsaction.yml, the wiki and the README — not applicable, none changedCONTEXT.md; a hard-to-reverse decision has an ADR — not applicable, no new vocabulary or decisiondocs/docs-consistency.test.tspasses, so the docs and the code still agreeAdditional Notes
Two things worth a reviewer's eye:
GIF (mandatory)
Thanks for contributing! ✨
Generated by Claude Code