Skip to content

Add docs for fern docs link check CLI command #5514

Merged
fern-support merged 4 commits into
mainfrom
fern/docs-link-check-cli
May 14, 2026
Merged

Add docs for fern docs link check CLI command #5514
fern-support merged 4 commits into
mainfrom
fern/docs-link-check-cli

Conversation

@fern-api
Copy link
Copy Markdown
Contributor

@fern-api fern-api Bot commented May 14, 2026

Adds documentation for the new fern docs link check CLI command, which validates links on live documentation sites by crawling the published site.

Changes

  • commands.mdx: Added fern docs link check to the Documentation commands table and a detailed Accordion section documenting the command, its flags (--url, --output), example output, and a comparison table distinguishing it from the broken-links rule in fern check
  • commands.mdx: Updated the fern check section to cross-reference fern docs link check as an option for checking links on published sites
  • markdown-basics.mdx: Updated the "Validating links" section to mention fern docs link check alongside the Dashboard link checker

Requested by: Fern Support

@fern-api fern-api Bot requested a review from devalog as a code owner May 14, 2026 23:13
@fern-api
Copy link
Copy Markdown
Contributor Author

fern-api Bot commented May 14, 2026

Requested by: ryan
Slack thread: View conversation

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 14, 2026


## CLI link checker

You can now check for broken links on your live documentation site directly from the Fern CLI with `fern docs link check`. The command scrapes every page on your published site, checks all internal and external links, and reports broken (404) and blocked (403) URLs along with the source pages where they appear.
Copy link
Copy Markdown
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

@fern-support fern-support merged commit b513444 into main May 14, 2026
2 checks passed
@fern-support fern-support deleted the fern/docs-link-check-cli branch May 14, 2026 23:57
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.

2 participants