-
Notifications
You must be signed in to change notification settings - Fork 4
docs: document broken link checker feature in dashboard #2969
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
| @@ -0,0 +1,7 @@ | |||
| ## Broken link checker in the dashboard | |||
|
|
|||
| The Fern Dashboard now includes a broken link checker that scans your published documentation for broken links. The checker validates both internal links (links to other pages within your docs) and external links (links to external websites). | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated
| To check for broken links, open your docs site in the Fern Dashboard and navigate to the **Broken Links** section. The dashboard displays a list of any broken links found, including the page where the link appears and the target URL that failed. | ||
|
|
||
| <Note> | ||
| The dashboard broken link checker is recommended over the CLI's [`fern check --strict-broken-links`](/learn/cli-api/cli-reference/commands#strict-broken-links) option because it checks your live published site and validates external links that the CLI cannot verify. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'can't' instead of 'cannot'.
…ken-link-checker-docs
| @@ -0,0 +1,5 @@ | |||
| ## 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). | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated
Summary
Documents the new broken link checker feature available in the Fern Dashboard. The changes add:
fern check --strict-broken-linksfor comprehensive link checkingThe documentation emphasizes that the dashboard checker is recommended over the CLI because it validates both internal and external links on the live published site.
Review & Testing Checklist for Human
/learn/docs/preview-publish/publishing-your-docs#check-for-broken-linksand/learn/cli-api/cli-reference/commands#strict-broken-linksresolve correctly in the previewSuggested test plan: Open the preview link, navigate to the publishing-your-docs page, and verify the new section renders correctly. Click the internal links to ensure they work. Cross-reference with the actual dashboard to confirm the documentation matches the real feature.
Notes