docs: add documentation for edit-this-page launch property#3903
Open
devin-ai-integration[bot] wants to merge 3 commits intomainfrom
Open
docs: add documentation for edit-this-page launch property#3903devin-ai-integration[bot] wants to merge 3 commits intomainfrom
edit-this-page launch property#3903devin-ai-integration[bot] wants to merge 3 commits intomainfrom
Conversation
Co-Authored-By: bot_apk <apk@cognition.ai>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
Requested by: ryan stephen |
Co-Authored-By: bot_apk <apk@cognition.ai>
Contributor
|
🌿 Preview your docs: https://fern-preview-ed643938-392a-4a75-be14-1db74faa4d29.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
…xample Co-Authored-By: bot_apk <apk@cognition.ai>
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.
docs: add documentation for
edit-this-pagelaunchpropertySummary
Adds documentation for the previously undocumented
launchproperty on theedit-this-pageconfiguration. This property (added in CLI v3.47.0) controls where the "Edit this page" link directs users — when set todashboard, it opens the Fern dashboard editor instead of linking to GitHub.Changes:
fern/apis/docs-yml/definition/docs.yml): Addedlaunchfield toEditThisPageConfigwith a newEditThisPageLaunchTargetenum (github|dashboard)site-level-settings.mdx): Added aParamFieldforlaunch, addedlaunch: dashboardto the existing Single Instance example in the GitHub configuration section, and updated theedit-this-pagesummary to mention thelaunchoptionUpdates since last revision
\"github\") with single quotes ('github') in theParamFieldtype attribute, matching the existing convention used elsewhere in the file (e.g.'filename' | 'frontmatter').launch: dashboardexample into the existing GitHub configuration "Single Instance" tab instead of having a separate example section.Review & Testing Checklist for Human
docs.ymlusage — confirm this matches the actual runtime behaviorlaunchis correctly placed as a sibling ofgithubin theEditThisPageConfigtype (not nested insideGithubEditThisPageConfig). This matches Fern's owndocs.ymlbut should be verified against the CLI parserParamFieldand inline example display correctly under the GitHub configuration sectionSuggested test plan: Deploy a preview and navigate to the site-level settings page → GitHub configuration section. Verify the
launchParamField renders correctly and thatlaunch: dashboardappears in the Single Instance YAML example.Notes