Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
devin-ai-integration wants to merge 3 commits into
base: main
Choose a base branch
from
+17 −1
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d9dd80b
docs: add documentation for edit-this-page launch property
devin-ai-integration[bot] Feb 27, 2026
6739105
fix: use single quotes in ParamField type to fix MDX parsing
devin-ai-integration[bot] Feb 27, 2026
40684a9
refactor: move launch: dashboard into existing GitHub configuration e…
devin-ai-integration[bot] Feb 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions fern/apis/docs-yml/definition/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,17 @@ types:
EditThisPageConfig:
properties:
github: optional<GithubEditThisPageConfig>
launch:
type: optional<EditThisPageLaunchTarget>
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:
Expand Down
7 changes: 6 additions & 1 deletion fern/products/docs/pages/customization/site-level-settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ instances:
</ParamField>

<ParamField path="instances.edit-this-page" type="object" required={false} toc={true}>
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).
</ParamField>

<ParamField path="instances.audiences" type="list of strings" required={false} toc={true}>
Expand Down Expand Up @@ -844,6 +844,7 @@ instances:
owner: fern
repo: plant-store-docs
branch: main
launch: dashboard
```
</Tab>

Expand Down Expand Up @@ -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`.
</ParamField>

<ParamField path="launch" type="'github' | 'dashboard'" required={false} toc={true}>
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`.
</ParamField>

## Landing page configuration

```yaml docs.yml
Expand Down