chore: backfill stale doc references and adopt **Version:** convention#8
Merged
Merged
Conversation
The release-doc-sync action now auto-maintains CHANGELOG.md and ROADMAP.md on each release. CLAUDE.md previously used hardcoded (v1.0.0) strings that release-doc-sync could not update. Three changes: 1. CHANGELOG.md gap acknowledgment for versions 1.0.1 through 1.2.x 2. CLAUDE.md hardcoded version references updated to current (v1.3.1) 3. CLAUDE.md adopts **Version:** convention so release-doc-sync maintains it going forward standards-version marker preserved. Documentation only. Refs TMHSDigital/Developer-Tools-Directory#5. Signed-off-by: 154358121+TMHSDigital@users.noreply.github.com Made-with: Cursor
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
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.
Summary
Backfill stale documentation references following Phase 2 doc-consistency rollout. Steam's CLAUDE.md previously used hardcoded
(v1.0.0)strings that release-doc-sync@v1.0 could not update. This PR backfills the historical CHANGELOG gap and adopts the**Version:**convention so the action keeps CLAUDE.md current going forward.Changes
[Versions 1.0.1 through 1.2.x]gap-acknowledgment entry between the auto-prepended v1.3.0 entry and the manually-written v1.0.0 entry. Points readers to GitHub releases for the complete history.(v1.0.0)from the project description (now version-agnostic prose)**Version:** 1.3.1/**License:** .../**Author:** ...metadata block in the Project Overview section, mirroring Docker's convention**Version:**line will now be auto-maintained by release-doc-sync on every release<!-- standards-version: 1.7.0 -->, line 1) preservedv1.0.0 "Stable"mention on line 13 is intentional - it documents the production milestone and will not be touched by future syncs (release-doc-sync only rewrites the immediately-previous version token)Rationale
Per the Phase 2e design (option 2): acknowledge the gap honestly rather than inventing synthetic release notes. Adopting
**Version:**convention closes the loop on Phase 2d - the test relaxation deferred this decision to a Steam content choice, and this PR makes it.Verification
git diff --stat: onlyCHANGELOG.md(+11) andCLAUDE.md(+8/-2)**Version:**line matches the regex release-doc-sync uses ((\*\*Version:\*\*\s+)v?(\d+\.\d+\.\d+))Refs TMHSDigital/Developer-Tools-Directory#5.