chore(docs): fix wrong-case repo links and stale version claims; stamp version at release#409
Merged
Merged
Conversation
…Attaform) The GitHub repo is `attaform/Attaform` (capital repo name), but two docs surfaces linked the lowercase `attaform/attaform`: the transforms-async demo's sample links and the public `llms.txt` index (its homepage source link, GitHub link, and CHANGELOG link). GitHub resolves the lowercase form by redirect, so nothing was broken, but the canonical case is correct and consistent now. The CHANGELOG's historical note about a prior lowercase-to-correct move is left as written. No hardcoded version pins exist in the docs to fix: the homepage release pill, the footer brand version, and the REPL dependency versions all read from package.json (nuxt.config runtimeConfig, with `pnpm version` the single bump point), and the bench's library versions come from results.json. The only hardcoded version references are intentional positioning copy (Vue 3, Nuxt 4). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Three version claims in the docs had drifted from reality, and the one that names the Attaform release now updates itself instead of being hand-bumped: - The OG image pinned "Nuxt 4" while the homepage tile, README, and the `nuxt >=3.0.0` peer all say "Nuxt 3 / 4". Matched it. - docs/server-and-ssr/performance.md claimed per-PR CI covers "Node 18 / 20 / 22 / LTS"; the test matrix runs only `lts/*` (22.x today) and `engines.node` is >=22 (Node 20 dropped at EOL). Reworded to the current LTS plus the engines floor. - docs/scorecard/cii-best-practices-answers.md hardcoded the current release (0.19.0). It is a raw GitHub-read audit trail (no frontmatter, not in the rendered content collection), so the site's build-time version injection cannot reach it. A new scripts/sync-doc-versions.mjs runs from the `version` npm hook (beside promote-changelog) and stamps package.json's version into it, riding the version commit. Same idea as the homepage reading package.json, for a file never rendered. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
ozzyfromspace
changed the title
This was referenced Jun 14, 2026
ozzyfromspace
added a commit
that referenced
this pull request
Jun 14, 2026
The `version` npm hook (since #409) stamps and `git add`s docs/scorecard/cii-best-practices-answers.md, but release-pr.yml still hard-coded a three-file bump allow-list in two places. The scorecard's `current:` marker changes on every bump, so it always landed as a fourth staged file and tripped the Stage bump assertion, blocking the release PR (run 27491924549). Derive the file set from the index instead of re-hard-coding it: Stage bump asserts a required set (CHANGELOG.md, RELEASES.md, package.json) plus an allowed-but-not-required slot for stamped docs, and Create signed bump commit builds its additions from the staged index so the two lists can no longer drift. The optional treatment matches sync-doc-versions's deliberate "never block on it" tolerance. Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
What
A docs-accuracy sweep: correct wrong-case repo links, fix three stale version claims, and make the
one doc that names the Attaform release stamp itself at release time instead of being hand-bumped.
Wrong-case repo links
Two surfaces linked the repo as lowercase
attaform/attaforminstead of the canonicalattaform/Attaform:apps/site/docs-demos/transforms-async/App.vue(a sample link in the links-to-URLs demo)apps/site/public/llms.txt(the homepage source, GitHub, and CHANGELOG links)GitHub redirects the lowercase form, so nothing was broken, but the canonical case is consistent now.
(The CHANGELOG's historical note about a prior fix is left as written.)
Stale version claims
nuxt >=3.0.0peer all say"Nuxt 3 / 4". Matched it. (It is a generated satori image, so worth an eyeball on the rendered card.)
docs/server-and-ssr/performance.mdclaimed per-PR CI covers "Node 18 / 20 / 22 / LTS". Thetest matrix runs only
lts/*(22.x today) andengines.nodeis>=22(Node 20 dropped at itsEOL). Reworded to the current LTS plus the engines floor; the Vue / Vite / Nuxt parts were already
correct.
Dynamic version, the right way for a raw doc
docs/scorecard/cii-best-practices-answers.mdhardcoded the current release (0.19.0; actual is0.21.2). The homepage and footer avoid this by reading the version frompackage.jsonat buildtime, but this doc is a raw GitHub-read audit trail (no frontmatter, excluded from the rendered
content collection), so render-time injection cannot reach it.
Instead, a new
scripts/sync-doc-versions.mjsruns from theversionnpm hook (besidepromote-changelog), stampspackage.json's version into the doc, and rides the version-bumpcommit, the same release-time pattern the changelog and release notes already use. Tested: a fake
old version restamps to the current one, and it is idempotent and tolerant (a missing marker or any
error is skipped, never failing a publish).
Notes
No other hardcoded versions remain: the homepage release pill, footer, and REPL dependency versions
all derive from
package.json; bench library versions come fromresults.json.🤖 Generated with Claude Code