diff --git a/fern/apis/docs-yml/definition/docs.yml b/fern/apis/docs-yml/definition/docs.yml index 51a88fe4c..f2984c01c 100644 --- a/fern/apis/docs-yml/definition/docs.yml +++ b/fern/apis/docs-yml/definition/docs.yml @@ -238,6 +238,17 @@ types: EditThisPageConfig: properties: github: optional + launch: + type: optional + docs: | + Controls where the "Edit this page" link directs users. + When set to `dashboard`, the link opens the page in the Fern dashboard editor instead of GitHub. + Defaults to `github`. + + EditThisPageLaunchTarget: + enum: + - github + - dashboard GithubEditThisPageConfig: properties: diff --git a/fern/products/docs/pages/customization/site-level-settings.mdx b/fern/products/docs/pages/customization/site-level-settings.mdx index 92966fac1..74f98886c 100644 --- a/fern/products/docs/pages/customization/site-level-settings.mdx +++ b/fern/products/docs/pages/customization/site-level-settings.mdx @@ -146,7 +146,7 @@ instances: - If specified, adds an "Edit this page" link to the bottom of each page that links to the given public GitHub repository. Learn more about the [`edit-this-page` configuration](#github-configuration). + If specified, adds an "Edit this page" link to the bottom of each page that links to the given public GitHub repository. You can optionally set a `launch` target to control where the link directs users. Learn more about the [`edit-this-page` configuration](#github-configuration). @@ -844,6 +844,7 @@ instances: owner: fern repo: plant-store-docs branch: main + launch: dashboard ``` @@ -884,6 +885,10 @@ The GitHub repository must be **public** for the "Edit this page" feature to wor The branch of the repository you would like the GitHub editor to open a PR to. Default is `main`. + + Controls where the "Edit this page" link directs users. When set to `dashboard`, the link opens the page in the Fern dashboard editor instead of GitHub. Defaults to `github`. + + ## Landing page configuration ```yaml docs.yml