Skip to content

Minor docs updates - #343

Merged
skarim merged 4 commits into
skarim/rebase-onto-amended-commitsfrom
skarim/docs-minor-updates
Jul 29, 2026
Merged

Minor docs updates#343
skarim merged 4 commits into
skarim/rebase-onto-amended-commitsfrom
skarim/docs-minor-updates

Conversation

@skarim

@skarim skarim commented Jul 28, 2026

Copy link
Copy Markdown
Collaborator
  • Corrects the README, docs, CLI help, and agent skill to describe stack pushes as non-atomic, with explicit per-branch --force-with-lease checks and partial-success retry behavior.
  • Clarifies that gh stack push pushes only active branches — excluding merged and queued branches — across the README, gh stack push help text, and agent skill.
  • Documents the 100-PR stack limit in the FAQ.
  • Documents that the pull_request.opened webhook never carries a stack object (a PR is added to a stack only after it's opened) and that the stacked action is the event that signals stack membership — added an intro note and strengthened the stacked section in the Webhooks reference, plus a new FAQ entry.

Stack created with GitHub Stacks CLIGive Feedback 💬

Copilot AI review requested due to automatic review settings July 28, 2026 21:29

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates documentation to accurately explain non-atomic stack pushes and the 100-PR limit.

Changes:

  • Documents per-branch force-with-lease behavior.
  • Clarifies partial push outcomes and retries.
  • Adds the 100-PR stack limit.
Show a summary per file
File Description
skills/gh-stack/SKILL.md Updates agent guidance for push and submit.
README.md Revises push behavior documentation.
docs/src/content/docs/reference/cli.md Updates CLI push reference.
docs/src/content/docs/guides/workflows.md Clarifies rebase/push workflow behavior.
docs/src/content/docs/faq.md Documents the stack size limit.
cmd/push.go Corrects push command help and comment.

Review details

  • Files reviewed: 6/6 changed files
  • Comments generated: 3
  • Review effort level: Medium

Comment thread README.md Outdated
Comment thread docs/src/content/docs/reference/cli.md Outdated
Comment thread skills/gh-stack/SKILL.md
@skarim
skarim changed the base branch from skarim/rebase-onto-amended-commits to skarim/sync-server-rebases July 28, 2026 22:35
@skarim
skarim force-pushed the skarim/docs-minor-updates branch 3 times, most recently from 986dd96 to 6620a7b Compare July 29, 2026 02:16
@skarim
skarim changed the base branch from skarim/sync-server-rebases to skarim/rebase-onto-amended-commits July 29, 2026 10:50
@skarim
skarim force-pushed the skarim/docs-minor-updates branch from 266f465 to c6d87ee Compare July 29, 2026 10:50
@skarim
skarim merged commit fded736 into main Jul 29, 2026
4 checks passed
@skarim
skarim deleted the skarim/docs-minor-updates branch July 29, 2026 17:32
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.

3 participants