Skip to content

docs: add fern docs md check command to CLI reference#4495

Merged
Ryan-Amirthan merged 3 commits intomainfrom
devin/1774222341-docs-md-check-command
Mar 23, 2026
Merged

docs: add fern docs md check command to CLI reference#4495
Ryan-Amirthan merged 3 commits intomainfrom
devin/1774222341-docs-md-check-command

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Mar 22, 2026

Summary

Documents the new fern docs md check CLI command (added in fern-api/fern@a8b3f2e, CLI v4.43.0) on the CLI reference commands page.

Changes:

  • Added a row to the Documentation commands table linking to the new section
  • Added an accordion section describing the command's usage, success output, and error output format

Updates since last revision

  • Clarified that the command validates MDX files across all navigation configuration files (including versioned configs and product-specific YAML files), not just docs.yml

Review & Testing Checklist for Human

  • Verify the example error output format matches what the actual CLI produces (the examples are representative, not copied from real output — run fern docs md check on a project with a syntax error to compare)
  • Confirm the claim that the command covers versioned configuration files and product-specific YAML files is accurate (based on the parseDocsConfiguration + getAllPages code path)
  • Check that the anchor link #fern-docs-md-check resolves correctly on the preview page

Notes

  • The changelog entry for this command already exists on main at cli-changelog/2026-03-22.mdx
  • The command takes no options, so the docs section is intentionally simple

Link to Devin session: https://app.devin.ai/sessions/0b40cea8ae384c72a09b94bc27750ca6

Co-Authored-By: bot_apk <apk@cognition.ai>
@devin-ai-integration devin-ai-integration bot requested a review from devalog as a code owner March 22, 2026 23:33
@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

@fern-api
Copy link
Contributor

fern-api bot commented Mar 22, 2026

Requested by: ryan
Slack thread: View conversation

@github-actions
Copy link
Contributor

@Ryan-Amirthan Ryan-Amirthan merged commit c3c2421 into main Mar 23, 2026
2 checks passed
@Ryan-Amirthan Ryan-Amirthan deleted the devin/1774222341-docs-md-check-command branch March 23, 2026 12:52
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