Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Dec 19, 2025

Summary

Adds a new section to the "Publishing your docs" page explaining how to set up separate staging and production documentation sites. This addresses a common customer workflow where teams want to preview changes on a staging site before publishing to production.

The new section covers:

  • Configuring multiple instances in docs.yml (with the important note that URLs should not include https://)
  • Using the --instance flag to publish to a specific environment
  • GitHub Actions workflows for auto-deploying to staging and manually deploying to production

Updates since last revision

Enhanced the GitHub workflow examples based on a real customer implementation:

  • Added workflow_dispatch trigger to staging workflow (allows manual triggering in addition to auto-deploy on push)
  • Added fern check validation step before deploying to catch configuration errors early
  • Renamed job from run to deploy for clarity

Local Testing Completed

  • Ran fern docs dev locally and verified the new section renders correctly
  • Steps and Accordion components display properly
  • Code blocks have correct syntax highlighting
  • Visual verification confirmed all formatting is professional and consistent

Local testing recording

View original video (rec-1609bf99d0c94acea32f96d3896545fa-edited.mp4)

Review & Testing Checklist for Human

  • Verify the --instance flag syntax is correct (e.g., fern generate --docs --instance plantstore-staging.docs.buildwithfern.com)
  • Confirm that instance URLs in docs.yml should NOT include https:// - this was a key issue discovered in customer support
  • Test the GitHub Actions workflow examples are valid YAML and follow best practices
  • Preview the rendered documentation to ensure the Steps and Accordion components display correctly

Recommended test plan: Run fern docs dev locally and navigate to the Publishing your docs page to verify the new section renders correctly with proper formatting.

Notes

  • This documentation is based on a customer support thread where the https:// prefix issue caused publishing failures
  • Workflow examples updated based on a real customer's staging/production setup
  • Uses "plantstore" as the example organization to match existing examples on the same page
  • One pre-existing Vale error remains on line 182 (in content not modified by this PR)

Link to Devin run: https://app.devin.ai/sessions/26b48e26643b41edb363c03490d64994
Requested by: Danny Sheridan (@dannysheridan)

@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

@github-actions
Copy link
Contributor

Assignee Required

This PR was opened by Devin AI but the requester's email ([email protected]) is not in the username mapping. Please add an assignee manually.

@github-actions
Copy link
Contributor

@devalog devalog self-assigned this Dec 19, 2025
@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

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