Skip to content

Commit 5548b49

Browse files
committed
remove private preview mentions from docs
1 parent a1b4a3d commit 5548b49

6 files changed

Lines changed: 3 additions & 31 deletions

File tree

‎README.md‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ A GitHub CLI extension for managing stacked branches and pull requests.
44

55
Stacked PRs break large changes into a chain of small, reviewable pull requests that build on each other. `gh stack` automates the tedious parts — creating branches, keeping them rebased, setting correct PR base branches, and navigating between layers.
66

7-
> [!NOTE]
8-
> Stacked PRs is currently in private preview. This CLI and the referenced functionality will not work unless the feature has been enabled for your repository.
9-
> You can sign up for the waitlist at [gh.io/stacksbeta](https://gh.io/stacksbeta).
10-
117
## Installation
128

139
```sh
@@ -722,5 +718,3 @@ See [CODEOWNERS](CODEOWNERS)
722718
## Support
723719

724720
See [SUPPORT.md](SUPPORT.md)
725-
726-
Please note that the Stacked PRs feature is currently in private preview and **gh-stack** will not work without that feature enabled.

‎SUPPORT.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ For help or questions about using this project, please use GitHub Discussions. A
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

11-
Please note that the Stacked PRs feature is currently in private preview and **gh-stack** will not work without that feature enabled.
12-
1311
## GitHub Support Policy
1412

1513
Support for this project is limited to the resources listed above.

‎docs/src/content.config.ts‎

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,10 @@
1-
import { defineCollection, z } from 'astro:content';
1+
import { defineCollection } from 'astro:content';
22
import { docsLoader } from '@astrojs/starlight/loaders';
33
import { docsSchema } from '@astrojs/starlight/schema';
44

55
export const collections = {
66
docs: defineCollection({
77
loader: docsLoader(),
8-
schema: docsSchema({
9-
extend: z.object({
10-
banner: z.object({
11-
content: z.string(),
12-
}).default({
13-
content: 'Stacked PRs is currently in private preview. <a href="https://gh.io/stacksbeta">Sign up for the waitlist →</a>',
14-
}),
15-
}),
16-
}),
8+
schema: docsSchema(),
179
}),
1810
};

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,6 @@ description: Install the gh stack CLI and create your first Stacked PR in minute
99
- Git 2.20 or later
1010
- A GitHub repository you can push to
1111

12-
:::caution[Private Preview]
13-
Stacked PRs is currently in private preview. This feature will **not work** unless enabled for your repository. [Sign up for the waitlist →](https://gh.io/stacksbeta)
14-
:::
15-
1612
## Install the CLI Extension
1713

1814
```sh

‎docs/src/content/docs/index.mdx‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ hero:
1515
icon: right-arrow
1616
---
1717

18-
import { Card, CardGrid, Aside } from '@astrojs/starlight/components';
18+
import { Card, CardGrid } from '@astrojs/starlight/components';
1919
import { Image } from 'astro:assets';
2020
import StackDiagram from '../../components/StackDiagram.astro';
2121
import stackNavigator from '../../assets/screenshots/stack-navigator.png';
@@ -59,10 +59,6 @@ When you're ready to merge, click **Merge** on the highest PR you want to land
5959

6060
## Get Started
6161

62-
<Aside type="caution" title="Private Preview">
63-
Stacked PRs is currently in private preview. This feature will **not work** unless enabled for your repository. [Sign up for the waitlist →](https://gh.io/stacksbeta)
64-
</Aside>
65-
6662
```sh
6763
# Install the CLI extension
6864
gh extension install github/gh-stack

‎docs/src/content/docs/reference/rest-api.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@ GitHub exposes stacks through the REST API in two ways:
88
1. **A `stack` object on pull request resources** — every pull request returned by the REST API carries a `stack` object describing its stack membership when it belongs to one.
99
2. **A dedicated Stacks API** — endpoints to list, read, create, extend, and dissolve stacks directly.
1010

11-
:::caution[Private Preview]
12-
Stacked PRs is currently in private preview. These endpoints are only available for repositories where the feature is enabled. [Sign up for the waitlist →](https://gh.io/stacksbeta)
13-
:::
14-
1511
## The `stack` object on Pull Requests
1612

1713
When a pull request belongs to a stack, GitHub includes a `stack` object on the pull request resource. This lets you read a PR's stack membership — the stack it belongs to, its size, and this PR's position within it — directly from the pull request, without a separate lookup.

0 commit comments

Comments
 (0)