chore(cli): Add changelog entry for broken link checks (#5580)

* Add changelog entry for broken link checks * chore: update changelog * Add additional info + documentation * chore: update changelog --------- Co-authored-by: rpc333 <[email protected]>
fern-api · Jan 10, 2025 · df0a16c · df0a16c
1 parent f17903e
commit df0a16c
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 0 deletions.
diff --git a/fern/pages/changelogs/cli/2025-01-10.mdx b/fern/pages/changelogs/cli/2025-01-10.mdx
@@ -0,0 +1,7 @@
+## 0.47.2
+**`(feat):`** The CLI now supports checking for broken links in your docs. You will see warnings in `fern check` if your docs link to any 
+page that can't be resolved, and the `--strict-broken-links` option will cause the command to fail (exit with a non-zero exit code) if 
+any broken links are found. You can also run the new command `fern docs broken-links` to only check for broken links (ignoring 
+other possible errors), with the `--strict` option to cause the command to fail if any broken links are found.
+
+
diff --git a/fern/pages/cli-api/commands.mdx b/fern/pages/cli-api/commands.mdx
@@ -35,6 +35,15 @@ Explore documentation for popular Fern CLI commands.
     fern check --warnings
     ```
 
+    ### strict-broken-links
+
+    Use `--strict-broken-links` to cause the command to fail (exit with a non-zero exit code) if any broken
+    links are found in your API docs.
+
+    ```bash
+    fern check --strict-broken-links
+    ```
+
     ## Usage in a GitHub Action
 
     <CodeBlock title = ".github/workflows/fern-check.yml" >
@@ -180,6 +189,28 @@ Explore documentation for popular Fern CLI commands.
   </Accordion>
 
 
+  <Accordion title="fern docs broken-links">
+
+    Use `fern docs broken-links` to check for broken links in your API docs.
+
+    <CodeBlock title="terminal">
+    ```bash
+    fern docs broken-links [--strict]
+    ```
+    </CodeBlock>
+
+    ### strict
+
+    Use `--strict-broken-links` to cause the command to fail (exit with a non-zero exit code) if any broken
+    links are found in your API docs.
+
+    ```bash
+    fern check --strict-broken-links
+    ```
+
+  </Accordion>
+
+
   <Accordion title="fern upgrade">
 
     Use `fern upgrade` will upgrade your compiler version in `fern.config.json` to the

diff --git a/packages/cli/cli/versions.yml b/packages/cli/cli/versions.yml
@@ -1,3 +1,13 @@
+- changelogEntry:
+  - summary: |
+      The CLI now supports checking for broken links in your docs. You will see warnings in `fern check` if your docs link to any 
+      page that can't be resolved, and the `--strict-broken-links` option will cause the command to fail (exit with a non-zero exit code) if 
+      any broken links are found. You can also run the new command `fern docs broken-links` to only check for broken links (ignoring 
+      other possible errors), with the `--strict` option to cause the command to fail if any broken links are found.
+    type: feat
+  irVersion: 53
+  version: 0.47.2
+
 - changelogEntry:
   - summary: |
       Fixes a bug where the OpenAPI parser stopped respecting the =`unions: v1` setting in your `generators.yml` which configures the parser to generate more