Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

Summary

Documents the new broken link checker feature available in the Fern Dashboard. The changes add:

  1. A new "Check for broken links" section to the publishing-your-docs page explaining how to use the dashboard's broken link checker
  2. A note in the CLI commands page recommending the dashboard over fern check --strict-broken-links for comprehensive link checking
  3. A changelog entry for the new feature

The 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

  • Verify the dashboard feature exists: Confirm the Fern Dashboard actually has a "Broken Links" section as described, and that the navigation instructions are accurate
  • Verify feature description accuracy: Confirm the broken link checker validates both internal and external links as documented
  • Test internal links: Verify /learn/docs/preview-publish/publishing-your-docs#check-for-broken-links and /learn/cli-api/cli-reference/commands#strict-broken-links resolve correctly in the preview
  • Review recommendation wording: Confirm it's appropriate to recommend the dashboard over CLI for link checking

Suggested 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

@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@@ -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).
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 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.
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 🐶
[Microsoft.Contractions] Use 'can't' instead of 'cannot'.

@github-actions
Copy link
Contributor

github-actions bot commented Jan 5, 2026

@github-actions
Copy link
Contributor

github-actions bot commented Jan 6, 2026

@github-actions
Copy link
Contributor

github-actions bot commented Jan 6, 2026

@github-actions
Copy link
Contributor

github-actions bot commented Jan 6, 2026

@github-actions
Copy link
Contributor

github-actions bot commented Jan 6, 2026

@github-actions
Copy link
Contributor

github-actions bot commented Jan 6, 2026

@github-actions
Copy link
Contributor

github-actions bot commented Jan 6, 2026

@@ -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).
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

@github-actions
Copy link
Contributor

github-actions bot commented Jan 6, 2026

@github-actions
Copy link
Contributor

github-actions bot commented Jan 6, 2026

@devalog devalog merged commit 639748d into main Jan 6, 2026
2 checks passed
@devalog devalog deleted the fern/broken-link-checker-docs branch January 6, 2026 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants