Skip to content

docs: document preview link management CLI commands#6007

Merged
devalog merged 3 commits into
mainfrom
devin/1782513753-document-preview-link-management
Jun 27, 2026
Merged

docs: document preview link management CLI commands#6007
devalog merged 3 commits into
mainfrom
devin/1782513753-document-preview-link-management

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Summary

Adds a "Manage preview links" section to preview-changes-locally.mdx documenting:

  • Preview links persist indefinitely (no auto-expiration)
  • fern docs preview list — lists active preview deployments with URLs and timestamps; supports --limit and --page
  • fern docs preview delete <url> / fern docs preview delete --id <id> — removes a preview deployment
  • Any org member can run these commands (no admin role required)
  • Preview URL pattern: {org}-preview-{hash}.docs.buildwithfern.com

Cross-references added on related pages:

  • publishing-your-docs.mdx — inline link to preview links in intro paragraph
  • commands.mdxfern docs preview list and fern docs preview delete accordion descriptions now link to the canonical manage-preview-links section

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.

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 🐶
[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.

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 🐶
[Microsoft.Contractions] Use 'they're' instead of 'they are'.

@github-actions

Copy link
Copy Markdown
Contributor

```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).

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 🐶
[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.

@devalog devalog merged commit f176eaa into main Jun 27, 2026
4 checks passed
@devalog devalog deleted the devin/1782513753-document-preview-link-management branch June 27, 2026 00:01
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.

1 participant