Add GitHub and GitLab setup details to Fern Editor page#4257
Add GitHub and GitLab setup details to Fern Editor page#4257fern-api[bot] wants to merge 3 commits intomainfrom
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| </Card> | ||
| </CardGroup> | ||
|
|
||
| ## Connect a Git provider |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'Connect a Git provider' should use sentence-style capitalization.
|
|
||
| GitHub is automatically connected when you install the [Fern GitHub app](https://github.com/apps/fern-api). No additional setup is required. | ||
|
|
||
| ### GitLab |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'GitLab' should use sentence-style capitalization.
|
🌿 Preview your docs: https://fern-preview-bc7b9ed6-2b64-4a60-9d9c-5889cc080945.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
|
Requested by: devin |
| <Tab title="GitLab"> | ||
| 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. |
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'future' that become outdated
|
|
||
| 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 |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'Open the Editor' should use sentence-style capitalization.
| ### 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. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Microsoft.Wordiness] Consider using 'drag' instead of 'drag and drop'.
1 participant
Summary
Adds a "Connect a Git provider" section to the Fern Editor page explaining how to connect GitHub and GitLab repositories to the visual editor:
read_user,api,write_repository,read_repository,read_api) and contact Fern support.Also updates the "Getting started" section to link to the new provider setup details instead of only referencing GitHub.
Updates since last revision
GitandGitLabto the ValeFernStyles/Headings.ymlexceptions list to resolve heading capitalization warnings flagged by the Vale CI check.Review & Testing Checklist for Human
read_user,api,write_repository,read_repository,read_api) match what Fern actually requires — these were sourced from Slack thread contextNotes