Skip to content

docs: add documentation for edit-this-page launch property#3903

Open
devin-ai-integration[bot] wants to merge 3 commits intomainfrom
devin/1772226116-edit-this-page-launch-docs
Open

docs: add documentation for edit-this-page launch property#3903
devin-ai-integration[bot] wants to merge 3 commits intomainfrom
devin/1772226116-edit-this-page-launch-docs

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Feb 27, 2026

docs: add documentation for edit-this-page launch property

Summary

Adds documentation for the previously undocumented launch property on the edit-this-page configuration. This property (added in CLI v3.47.0) controls where the "Edit this page" link directs users — when set to dashboard, it opens the Fern dashboard editor instead of linking to GitHub.

Changes:

  • API definition (fern/apis/docs-yml/definition/docs.yml): Added launch field to EditThisPageConfig with a new EditThisPageLaunchTarget enum (github | dashboard)
  • Site-level settings page (site-level-settings.mdx): Added a ParamField for launch, added launch: dashboard to the existing Single Instance example in the GitHub configuration section, and updated the edit-this-page summary to mention the launch option

Updates since last revision

  • Fixed MDX parsing error: replaced escaped double quotes (\"github\") with single quotes ('github') in the ParamField type attribute, matching the existing convention used elsewhere in the file (e.g. 'filename' | 'frontmatter').
  • Consolidated the launch: dashboard example into the existing GitHub configuration "Single Instance" tab instead of having a separate example section.

Review & Testing Checklist for Human

  • Verify the feature description is accurate: The behavior ("opens the page in the Fern dashboard editor") was inferred from the CLI changelog and Fern's own docs.yml usage — confirm this matches the actual runtime behavior
  • Confirm launch is correctly placed as a sibling of github in the EditThisPageConfig type (not nested inside GithubEditThisPageConfig). This matches Fern's own docs.yml but should be verified against the CLI parser
  • Check the rendered docs page to ensure the new ParamField and inline example display correctly under the GitHub configuration section

Suggested test plan: Deploy a preview and navigate to the site-level settings page → GitHub configuration section. Verify the launch ParamField renders correctly and that launch: dashboard appears in the Single Instance YAML example.

Notes

Co-Authored-By: bot_apk <apk@cognition.ai>
@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

@fern-api
Copy link
Contributor

fern-api bot commented Feb 27, 2026

Requested by: ryan stephen
Slack thread: View conversation

Co-Authored-By: bot_apk <apk@cognition.ai>
@github-actions
Copy link
Contributor

github-actions bot commented Feb 27, 2026

…xample

Co-Authored-By: bot_apk <apk@cognition.ai>
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.

0 participants