Skip to content

docs: document the gh-stack stack provider - #69

Open
lettertwo wants to merge 2 commits into
gh-stack-write-pathfrom
gh-stack-docs
Open

docs: document the gh-stack stack provider#69
lettertwo wants to merge 2 commits into
gh-stack-write-pathfrom
gh-stack-docs

Conversation

@lettertwo

@lettertwo lettertwo commented Aug 28, 2026

Copy link
Copy Markdown
Owner

Documentation only, no code. Split out so the code changes stay reviewable on their diffs alone.

docs/adr/028-provider-neutral-stack-metadata.md is new and carries the decisions the gh-stack work
implements: the shared StackMetadata boundary, why reads never shell out, why Graphite wins
detection, why workon new writes the gh-stack file itself, and the canonical-file-plus-symlinks
layout. 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.md gains the gh-stack workflow alongside the Graphite one.
docs/rfc/stacked-diffs.md, README.md, and docs/INDEX.md pick up the second provider. ADR-023
and 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 CLIGive Feedback 💬

@lettertwo lettertwo changed the title gh stack docs docs: document the gh-stack stack provider Aug 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant