docs: document preview link management CLI commands#6007
Merged
Conversation
Add a "Manage preview links" section to the preview-changes page documenting:
- Preview links persist indefinitely (no auto-expiration)
- `fern docs preview list` command with --limit and --page options
- `fern docs preview delete` command (by URL or --id)
- Any org member can run these commands (no admin role required)
- Preview URL pattern: {org}-preview-{hash}.docs.buildwithfern.com
Also add cross-references from publishing-your-docs.mdx and commands.mdx
to improve discoverability of preview management documentation.
| You can [delete a preview deployment](/learn/cli-api-reference/cli-reference/commands#fern-docs-preview-delete) when it's no longer needed: | ||
| ### Manage preview links | ||
|
|
||
| Preview links persist indefinitely — Fern does not auto-expire them. Use the commands below to list and remove previews when they are no longer needed. Any organization member can run these commands; no admin role is required. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.
| You can [delete a preview deployment](/learn/cli-api-reference/cli-reference/commands#fern-docs-preview-delete) when it's no longer needed: | ||
| ### Manage preview links | ||
|
|
||
| Preview links persist indefinitely — Fern does not auto-expire them. Use the commands below to list and remove previews when they are no longer needed. Any organization member can run these commands; no admin role is required. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'they're' instead of 'they are'.
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1782513753-document-preview-link-management.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
| ```bash | ||
| fern docs preview delete <url> | ||
| ``` | ||
| Preview links persist indefinitely — Fern does not auto-expire them. Any organization member can use [`fern docs preview list`](/learn/cli-api-reference/cli-reference/commands#fern-docs-preview-list) to see active previews and [`fern docs preview delete`](/learn/cli-api-reference/cli-reference/commands#fern-docs-preview-delete) to remove them when they're no longer needed. To clean up previews automatically when PRs merge, set up a [GitHub Actions workflow](#clean-up-preview-links-when-prs-merge). |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.
devalog
approved these changes
Jun 26, 2026
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
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
Adds a "Manage preview links" section to
preview-changes-locally.mdxdocumenting:fern docs preview list— lists active preview deployments with URLs and timestamps; supports--limitand--pagefern docs preview delete <url>/fern docs preview delete --id <id>— removes a preview deployment{org}-preview-{hash}.docs.buildwithfern.comCross-references added on related pages:
publishing-your-docs.mdx— inline link to preview links in intro paragraphcommands.mdx—fern docs preview listandfern docs preview deleteaccordion descriptions now link to the canonical manage-preview-links section