Skip to content

Commit 639748d

Browse files
devin-ai-integration[bot]fern-api[bot]devalogdannysheridan
authored
docs: document broken link checker feature in dashboard (#2969)
Co-authored-by: fern-api[bot] <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: Devin Logan <[email protected]> Co-authored-by: Danny Sheridan <[email protected]>
1 parent 523e600 commit 639748d

File tree

6 files changed

+39
-10
lines changed

6 files changed

+39
-10
lines changed

fern/products/cli-api-reference/pages/commands.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,10 @@ hideOnThisPage: true
284284
fern check --strict-broken-links
285285
```
286286

287+
<Note>
288+
For comprehensive link checking, use the [Fern Dashboard](https://dashboard.buildwithfern.com/), which validates both internal and external links on your live published site. This is recommended over `--strict-broken-links` because the Dashboard checks your actual published site and can verify external links that the CLI cannot.
289+
</Note>
290+
287291
## Usage in a GitHub Action
288292

289293
<CodeBlock title = ".github/workflows/fern-check.yml" >

fern/products/dashboard/dashboard.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@ navigation:
1111
- page: Set up SSO
1212
path: ./pages/sso.mdx
1313
slug: sso
14+
- changelog: ./pages/changelog
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
## Broken link checker
2+
3+
The Fern Dashboard now includes a link checker that scans your published documentation for broken links, validating both internal links (links to other pages within your docs) and external links (links to external websites).
4+
5+
To check for broken links, open the [Fern Dashboard](https://dashboard.buildwithfern.com), navigate to the **Link Checker** tab, and select the domain you want to scan. The checker displays any broken (404) or blocked (403) links found, along with the source page and link type.
6+
7+
8+
<Frame>
9+
<img src="link-checker.png" alt="Dashboard Link Checker tool" />
10+
</Frame>
196 KB
Loading

fern/products/dashboard/pages/overview.mdx

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,11 @@ Visit your team's [Dashboard](https://dashboard.buildwithfern.com/) and complete
3131
</Card>
3232
</CardGroup>
3333

34-
## Ongoing usage
34+
## Metrics
3535

36-
Once you've completed initial setup tasks, use your dashboard to monitor and manage your documentation:
36+
Monitor and analyze how developers interact with your documentation:
3737

3838
<CardGroup cols={3}>
39-
<Card
40-
title="Site information"
41-
icon="regular info-circle"
42-
>
43-
View deployment status, domains, CLI version, and GitHub repo details.
44-
</Card>
4539
<Card
4640
title="Web analytics"
4741
icon="regular chart-line"
@@ -54,6 +48,12 @@ Once you've completed initial setup tasks, use your dashboard to monitor and man
5448
>
5549
Monitor search queries to understand what developers are looking for in your docs.
5650
</Card>
51+
<Card
52+
title="Broken links"
53+
icon="regular link-slash"
54+
>
55+
Scan your published docs for broken internal and external links.
56+
</Card>
5757
<Card
5858
title="Feedback"
5959
icon="regular comment-dots"
@@ -69,7 +69,7 @@ Once you've completed initial setup tasks, use your dashboard to monitor and man
6969
</p>
7070

7171
</Card>
72-
<Card
72+
<Card
7373
title="Ask Fern conversations"
7474
icon="regular messages"
7575
href="/learn/ask-fern/getting-started/what-is-ask-fern"
@@ -84,6 +84,19 @@ Once you've completed initial setup tasks, use your dashboard to monitor and man
8484
</p>
8585

8686
</Card>
87+
</CardGroup>
88+
89+
## Site management
90+
91+
Manage your documentation site and team collaboration:
92+
93+
<CardGroup cols={3}>
94+
<Card
95+
title="Site information"
96+
icon="regular info-circle"
97+
>
98+
View deployment status, domains, CLI version, and GitHub repo details.
99+
</Card>
87100
<Card
88101
title="Fern Editor"
89102
icon="regular pen-to-square"

fern/products/docs/pages/getting-started/publishing-your-docs.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: Publish your Fern docs to production and staging sites with automat
66
When you are ready for your docs to be publicly accessible, publish them using the Fern CLI. Choose one of the following approaches: publish [only to a production site](#publish-to-production), or [to separate staging and production sites](#publish-to-staging-and-production).
77

88
<Info>
9-
Use the [Fern Dashboard](https://dashboard.buildwithfern.com) to manage CLI access and your GitHub repository connection.
9+
Use the [Fern Dashboard](https://dashboard.buildwithfern.com) to manage CLI access, connect your GitHub repository, and monitor analytics and broken links.
1010
</Info>
1111

1212
## Publish to production
@@ -206,3 +206,4 @@ navigation: []
206206
Publish the updated configuration by running `fern generate --docs`. This will remove all content from your site, and users visiting any page will see a 404 error.
207207
</Step>
208208
</Steps>
209+

0 commit comments

Comments
 (0)