diff --git a/.vale/styles/FernStyles/Headings.yml b/.vale/styles/FernStyles/Headings.yml index 8ff404f6e..a22807193 100644 --- a/.vale/styles/FernStyles/Headings.yml +++ b/.vale/styles/FernStyles/Headings.yml @@ -33,7 +33,9 @@ exceptions: - SDKs - API Reference - API Explorer + - Git - GitHub + - GitLab - README - Action - Actions diff --git a/fern/products/docs/pages/component-library/writing-content/visual-editor.mdx b/fern/products/docs/pages/component-library/writing-content/visual-editor.mdx index 0ba0bfd19..0aa4a2e8d 100644 --- a/fern/products/docs/pages/component-library/writing-content/visual-editor.mdx +++ b/fern/products/docs/pages/component-library/writing-content/visual-editor.mdx @@ -23,7 +23,7 @@ Fern Editor lets team members such as content writers, product managers, and mar ## Key features - + Create and edit Callouts, Cards, Accordions, Code Blocks, and other Fern components from the UI @@ -35,19 +35,40 @@ Fern Editor lets team members such as content writers, product managers, and mar Multiple team members can edit the same PR in the Editor without GitHub access - - - Supports private GitHub and GitLab instances. [Contact support](mailto:support@buildwithfern.com) to set up. - ## Getting started -Log in to the [Dashboard](https://dashboard.buildwithfern.com/), connect your GitHub repository, and open Fern Editor from the top navigation. + + +### Connect a Git provider + + +Private GitHub and GitLab instances are supported. [Contact support](mailto:support@buildwithfern.com) to set up. + + + + +Install the [Fern GitHub app](https://github.com/apps/fern-api), then [connect your repository](/learn/dashboard/configuration/github-repo) in the [Dashboard](https://dashboard.buildwithfern.com/). + + +GitLab requires manual setup: + +1. [Create a personal access token](https://gitlab.com/-/user_settings/personal_access_tokens) in GitLab with the following scopes: `api`, `read_repository`, `write_repository`. Set the expiration date far into the future to avoid disrupting your Editor experience — you can revoke the token at any time. +2. Contact Fern support via Slack or [email](mailto:support@buildwithfern.com) with your access token and GitLab repository URL. +3. Once Fern configures the connection, [connect your repository](/learn/dashboard/configuration/github-repo) in the [Dashboard](https://dashboard.buildwithfern.com/). + + + +### Set up permissions + +Configure [member permissions](/learn/dashboard/configuration/permissions) for your organization to control who can use Fern Editor. Admins and Editors can make changes; Viewers have read-only access. + +### Open the Editor -From the Editor you can drag and drop media, create and delete pages, update branding (logo, favicon, title), and switch to dev mode for source code editing. +Log in to the [Dashboard](https://dashboard.buildwithfern.com/) and open Fern Editor from the **Overview** tab. From here you can drag and drop media, create and delete pages, update branding (logo, favicon, title), and switch to dev mode for source code editing. -To manage access, see [Member permissions](/learn/dashboard/configuration/permissions). Admins and Editors can use the Editor; Viewers have read-only access. + Fern Editor supports modern Chromium browsers on desktop. Mobile editing and support for other browsers are coming soon.