docs: remove commit SHAs from history sections#31
Closed
Conversation
Embedded short SHAs in docs cause churn whenever the stack is restacked or amended. Removing these tokens avoids unnecessary diffs and broken anchors while preserving human-readable subject lines. Scope: - Delete footer lines that are exactly "Commit: " followed by 7–40 hex. - Strip leading short SHAs from "##" section headings so headings keep only the subject. - Only files under docs/*.md are edited. No code changes. Stable diff pointers (for future readers): - Prefer a GitHub compare URL anchored to branch names: https://github.com/ORG/REPO/compare/BASE_BRANCH...TOPIC_BRANCH - Or the PR URL (stable over time). Test plan: - Verify removal: grep -R -nE '(^Commit: [0-9a-fA-F]{7,40}$)|(^## [0-9a-fA-F]{7,40}\b)' docs || echo "No SHA/Commit lines remain" - Confirm scope: git --no-pager diff --name-only --cached | xargs -I{} bash -lc '[[ "{}" == docs/* ]] && echo OK: {}' - Render docs; headings show subjects without SHAs.
This was referenced Sep 12, 2025
Collaborator
Author
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.
Embedded short SHAs in docs cause churn whenever the stack is
restacked or amended. Removing these tokens avoids unnecessary diffs
and broken anchors while preserving human-readable subject lines.
Scope:
only the subject.
Stable diff pointers (for future readers):
https://github.com/ORG/REPO/compare/BASE_BRANCH...TOPIC_BRANCH
Test plan:
grep -R -nE '(^Commit: [0-9a-fA-F]{7,40}$)|(^## [0-9a-fA-F]{7,40}\b)' docs || echo "No SHA/Commit lines remain"
git --no-pager diff --name-only --cached | xargs -I{} bash -lc '[[ "{}" == docs/* ]] && echo OK: {}'