Skip to content

Commit 5858125

Browse files
Add changelog entry for preview workflow with direct page links (#4290)
Co-authored-by: fern-api[bot] <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: Devin Logan <devinannlogan@gmail.com>
1 parent 75b308b commit 5858125

3 files changed

Lines changed: 28 additions & 1 deletion

File tree

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
tags: ["local-development", "configuration"]
3+
---
4+
5+
## Preview workflow with direct page links
6+
7+
You can now use an updated GitHub Actions preview workflow that comments on your pull request with direct links to every page you changed, so reviewers can jump straight to affected pages without navigating through the full site. The comment updates with a new preview link and refreshed page links when you push new commits.
8+
9+
<Frame>
10+
<img
11+
src="../getting-started/images/markdown-links-preview.png"
12+
alt="GitHub Actions bot comment showing a preview URL and a list of direct links to changed documentation pages"
13+
/>
14+
</Frame>
15+
16+
To adopt this workflow, replace your `.github/workflows/preview-docs.yml` with the updated version. New sites created through the [guided UI](https://dashboard.buildwithfern.com/get-started) or [CLI quickstart](/learn/docs/getting-started/quickstart) include it automatically.
17+
18+
<Button intent="none" outlined rightIcon="arrow-right" href="/learn/docs/preview-publish/preview-changes#automate-with-github-actions">Read the docs</Button>
168 KB
Loading

fern/products/docs/pages/getting-started/preview-changes-locally.mdx

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,16 @@ fern docs preview delete <url>
6262

6363
### Automate with GitHub Actions
6464

65-
If you set up your site using the [guided UI](https://dashboard.buildwithfern.com/get-started) or [CLI quickstart](/learn/docs/getting-started/quickstart), preview workflow files are automatically included in your repository. Otherwise, add them manually using the examples below.
65+
You can use a GitHub Actions workflow to automatically generate a preview URL when a pull request is opened. The workflow posts a comment on the PR with the preview link and direct links to every page changed in the PR, so reviewers can jump straight to affected pages. When you push new commits, the comment is updated with a new preview link and refreshed page links.
66+
67+
<Frame>
68+
<img
69+
src="./images/markdown-links-preview.png"
70+
alt="GitHub Actions bot comment on a pull request showing a preview URL and direct links to changed documentation pages"
71+
/>
72+
</Frame>
73+
74+
If you set up your site using the [guided UI](https://dashboard.buildwithfern.com/get-started) or [CLI quickstart](/learn/docs/getting-started/quickstart), this workflow is automatically included in your repository. Otherwise, add it manually using the examples below.
6675

6776
These workflows require a `FERN_TOKEN` [repository secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository). If you used the guided workflow, this secret is added automatically. Otherwise, run [`fern token`](/learn/cli-api-reference/cli-reference/commands#fern-token) in your terminal to generate a token, then add it in your repository's **Settings > Secrets and variables > Actions** with the name `FERN_TOKEN`.
6877

0 commit comments

Comments
 (0)