docs: document the gh-stack stack provider - #69
Open
lettertwo wants to merge 2 commits into
Open
Conversation
lettertwo
force-pushed
the
gh-stack-docs
branch
from
August 28, 2026 03:13
c28a6b7 to
1f999ea
Compare
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.
Documentation only, no code. Split out so the code changes stay reviewable on their diffs alone.
docs/adr/028-provider-neutral-stack-metadata.mdis new and carries the decisions the gh-stack workimplements: the shared
StackMetadataboundary, why reads never shell out, why Graphite winsdetection, why
workon newwrites the gh-stack file itself, and the canonical-file-plus-symlinkslayout. It quotes the two upstream Go mechanics the symlink approach depends on with file
references, so the claims can be checked against
github/gh-stack.docs/recipes/stacked-diffs.mdgains the gh-stack workflow alongside the Graphite one.docs/rfc/stacked-diffs.md,README.md, anddocs/INDEX.mdpick up the second provider. ADR-023and ADR-024 get short amendments where provider-neutrality changed what they had described as
Graphite-specific.
ADR-028 is the one worth reading closely. The rest is cross-referencing and index upkeep.
Testing: 647 tests, clippy clean.
Stack created with GitHub Stacks CLI • Give Feedback 💬