Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions .vale/styles/FernStyles/Headings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ exceptions:
- SDKs
- API Reference
- API Explorer
- Git
- GitHub
- GitLab
- README
- Action
- Actions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Fern Editor lets team members such as content writers, product managers, and mar

## Key features

<CardGroup cols={2}>
<CardGroup cols={3}>
<Card title="Component support" icon="duotone puzzle-piece">
Create and edit Callouts, Cards, Accordions, Code Blocks, and other Fern components from the UI
</Card>
Expand All @@ -35,19 +35,40 @@ Fern Editor lets team members such as content writers, product managers, and mar
<Card title="Collaborative editing" icon="duotone users">
Multiple team members can edit the same PR in the Editor without GitHub access
</Card>

<Card title="Private Git providers" icon="duotone lock">
Supports private GitHub and GitLab instances. [Contact support](mailto:support@buildwithfern.com) to set up.
</Card>
</CardGroup>

## Getting started

Log in to the [Dashboard](https://dashboard.buildwithfern.com/), connect your GitHub repository, and open Fern Editor from the top navigation.
<Steps>

### Connect a Git provider

<Note title="Private instances">
Private GitHub and GitLab instances are supported. [Contact support](mailto:support@buildwithfern.com) to set up.
</Note>

<Tabs>
<Tab title="GitHub">
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/).
</Tab>
<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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[FernStyles.Current] Avoid time-relative terms like 'future' that become outdated

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/).
</Tab>
</Tabs>

### 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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'Open the Editor' should use sentence-style capitalization.


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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[Microsoft.Wordiness] Consider using 'drag' instead of 'drag and drop'.


To manage access, see [Member permissions](/learn/dashboard/configuration/permissions). Admins and Editors can use the Editor; Viewers have read-only access.
</Steps>

<Note title="Browser and device support">
Fern Editor supports modern Chromium browsers on desktop. Mobile editing and support for other browsers are coming soon.
Expand Down
Loading