Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions fern/products/cli-api-reference/pages/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -284,6 +284,10 @@ hideOnThisPage: true
fern check --strict-broken-links
```

<Note>
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.
</Note>

## Usage in a GitHub Action

<CodeBlock title = ".github/workflows/fern-check.yml" >
Expand Down
1 change: 1 addition & 0 deletions fern/products/dashboard/dashboard.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ navigation:
- page: Set up SSO
path: ./pages/sso.mdx
slug: sso
- changelog: ./pages/changelog
10 changes: 10 additions & 0 deletions fern/products/dashboard/pages/changelog/2026-01-05.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Broken link checker

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).
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated


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.


<Frame>
<img src="link-checker.png" alt="Dashboard Link Checker tool" />
</Frame>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 22 additions & 9 deletions fern/products/dashboard/pages/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,11 @@ Visit your team's [Dashboard](https://dashboard.buildwithfern.com/) and complete
</Card>
</CardGroup>

## Ongoing usage
## Metrics

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

<CardGroup cols={3}>
<Card
title="Site information"
icon="regular info-circle"
>
View deployment status, domains, CLI version, and GitHub repo details.
</Card>
<Card
title="Web analytics"
icon="regular chart-line"
Expand All @@ -54,6 +48,12 @@ Once you've completed initial setup tasks, use your dashboard to monitor and man
>
Monitor search queries to understand what developers are looking for in your docs.
</Card>
<Card
title="Broken links"
icon="regular link-slash"
>
Scan your published docs for broken internal and external links.
</Card>
<Card
title="Feedback"
icon="regular comment-dots"
Expand All @@ -69,7 +69,7 @@ Once you've completed initial setup tasks, use your dashboard to monitor and man
</p>

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

</Card>
</CardGroup>

## Site management

Manage your documentation site and team collaboration:

<CardGroup cols={3}>
<Card
title="Site information"
icon="regular info-circle"
>
View deployment status, domains, CLI version, and GitHub repo details.
</Card>
<Card
title="Fern Editor"
icon="regular pen-to-square"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Publish your Fern docs to production and staging sites with automat
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).

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

## Publish to production
Expand Down Expand Up @@ -206,3 +206,4 @@ navigation: []
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.
</Step>
</Steps>

Loading