docs: document check.rules configuration for fern check#4627
Merged
Conversation
Contributor
|
🌿 Preview your docs: https://fern-preview-fern-document-check-rules.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
Contributor
Author
|
Requested by: jon |
devalog
approved these changes
Mar 31, 2026
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| ## Configure `fern check` rule severity | ||
|
|
||
| You can now configure the severity of validation rules run by `fern check` directly in your `docs.yml` file using the `check.rules` property. Set individual rules to `"warn"` (non-blocking) or `"error"` (blocking) to control which checks fail your build. |
Contributor
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated
| example-validation: warn | ||
| ``` | ||
|
|
||
| The `--broken-links` and `--strict-broken-links` CLI flags are now deprecated in favor of this configuration. |
Contributor
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the
check.rulesconfiguration fordocs.yml, added in CLI v4.46.0.Changes:
commands.mdx: Marks--strict-broken-links(and--broken-links) as deprecated with a warning callout pointing to the newcheck.rulesapproach. Adds a "Configuring rule severity" subsection with a short example and link to the full reference.site-level-settings.mdx: Adds a new "Check configuration" section documenting all six configurable rules (broken-links,example-validation,no-non-component-refs,valid-local-references,no-circular-redirects,valid-docs-endpoints) with their types, defaults, and descriptions.Review & Testing Checklist for Human
broken-links,example-validation) must match whatfern checkactually accepts indocs.yml. The TypeScript types use camelCase (brokenLinks,exampleValidation) — confirm the YAML serialization layer converts correctly.broken-links: error,valid-local-references: warn) against the actual CLI behavior./learn/docs/configuration/site-level-settings#check-configurationincommands.mdxshould resolve to the new section on the site-level settings page. Verify via preview.Recommended test plan: Open the preview links and visually verify both pages render correctly — especially the ParamField components and the deprecation warning callout.
Notes
runCI job failed on the first commit due to escaped quotes (\") in MDXtypeattributes. Fixed in a follow-up commit by switching to single quotes ('warn' | 'error'), matching the existing pattern used elsewhere insite-level-settings.mdx.--strict-broken-linksdocumentation is preserved (not deleted) but marked deprecated, so existing users searching for it will find the migration path.Link to Devin session: https://app.devin.ai/sessions/03d07fb7ea8646ee84749db18f2f0855