Skip to content

Commit 8f0d62c

Browse files
skarimCopilot
andcommitted
docs cleanup suggestions from code review
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 08dc2da commit 8f0d62c

6 files changed

Lines changed: 10 additions & 10 deletions

File tree

SUPPORT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
This project uses GitHub issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new issue.
66

7-
For help or questions about using this project, please use GitHib discussions. Add a comment to an existing post or create a new discussion post.
7+
For help or questions about using this project, please use GitHub Discussions. Add a comment to an existing post or create a new discussion post.
88

99
**gh-stack** is under active development and maintained by GitHub staff. We will do our best to respond to support, feature requests, and community questions in a timely manner.
1010

docs/src/content/docs/faq.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ A stacked PR is a pull request that is part of an ordered chain of PRs, where ea
1414
You can create a stack using the `gh stack` CLI:
1515

1616
```sh
17-
gh stack init
17+
gh stack init auth-layer
1818
# ... make commits on the first branch ...
19-
gh stack add auth-layer
20-
# ... make commits ...
2119
gh stack add api-routes
2220
# ... make commits ...
21+
gh stack add request-validation
22+
# ... make commits ...
2323
gh stack submit
2424
```
2525

docs/src/content/docs/getting-started/quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,6 @@ This shows all branches, their PR links, statuses, and the most recent commit on
8989

9090
## What's Next?
9191

92-
- [Working with Stacked PRs](/gh-stack/guides/using-prs/) — Learn about the PR review and merge experience
92+
- [Working with Stacked PRs](/gh-stack/guides/stacked-prs/) — Learn about the PR review and merge experience
9393
- [Typical Workflows](/gh-stack/guides/workflows/) — Common patterns for day-to-day use
9494
- [CLI Reference](/gh-stack/reference/cli/) — Full command documentation

docs/src/content/docs/guides/stacked-prs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Practical guide for reviewing, merging, and managing stacked pull r
55

66
This guide covers the practical day-to-day experience of working with Stacked PRs — how to review them, how merging works step by step, and how to keep things in sync from the CLI.
77

8-
For an introduction to what stacks are and how GitHub supports them natively, see the [Overview](/gh-stack/introduction/overview/). For a visual walkthrough of the UI, see [Using Stacks in the GitHub UI](/gh-stack/guides/ui-walkthrough/).
8+
For an introduction to what stacks are and how GitHub supports them natively, see the [Overview](/gh-stack/introduction/overview/). For a visual walkthrough of the UI, see [Using Stacks in the GitHub UI](/gh-stack/guides/ui/).
99

1010
## Reviewing Stacked PRs
1111

docs/src/content/docs/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,12 @@ When you're ready to merge, you merge from the bottom up. Each PR can be merged
6666
gh extension install github/gh-stack
6767

6868
# Create a stack (creates and checks out the first branch)
69-
gh stack init
70-
# ... make commits ...
71-
gh stack add auth-layer
69+
gh stack init auth-layer
7270
# ... make commits ...
7371
gh stack add api-routes
7472
# ... make commits ...
73+
gh stack add frontend
74+
# ... make commits ...
7575

7676
# Push all branches
7777
gh stack push

docs/src/content/docs/introduction/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,6 @@ Create a new branch when you're starting a different concern that depends on wha
120120
## Next Steps
121121

122122
- [Quick Start](/gh-stack/getting-started/quick-start/) — Install the CLI and create your first stack
123-
- [Working with Stacked PRs](/gh-stack/guides/using-prs/) — Learn about the PR review and merge experience
123+
- [Working with Stacked PRs](/gh-stack/guides/stacked-prs/) — Learn about the PR review and merge experience
124124
- [Typical Workflows](/gh-stack/guides/workflows/) — Common patterns for day-to-day use
125125
- [CLI Reference](/gh-stack/reference/cli/) — Complete command documentation

0 commit comments

Comments
 (0)