Skip to content

Commit 363b217

Browse files
alecharmondevalog
alecharmon
and
devalog
authored
docs: Add Dashboard Product and SSO Page (#2850)
Co-authored-by: Devin Logan <[email protected]>
1 parent 6673904 commit 363b217

File tree

7 files changed

+327
-0
lines changed

7 files changed

+327
-0
lines changed

‎fern/docs.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,13 @@ products:
4545
slug: ask-fern
4646
subtitle: Let users find answers in your documentation instantly
4747

48+
- display-name: Dashboard
49+
path: ./products/dashboard/dashboard.yml
50+
icon: fa-regular fa-grid-2
51+
image: ./images/product-switcher/product-switcher-dashboard-light.png
52+
slug: dashboard
53+
subtitle: Manage your Fern projects and settings
54+
4855
- display-name: CLI Reference
4956
subtitle: Manage and configure your Fern projects
5057
path: ./products/cli-api-reference/cli-api-reference.yml

‎fern/images/product-switcher/product-switcher-dashboard-dark.png‎

8.2 KB
Loading

‎fern/images/product-switcher/product-switcher-dashboard-light.png‎

7.21 KB
Loading

‎fern/products/dashboard/dashboard.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
navigation:
2+
- section: Getting started
3+
contents:
4+
- page: Overview
5+
path: ./pages/overview.mdx
6+
- section: Configuration
7+
contents:
8+
- page: Member permissions
9+
path: ./pages/permissions.mdx
10+
slug: permissions
11+
- page: Set up SSO
12+
path: ./pages/sso.mdx
13+
slug: sso

‎fern/products/dashboard/pages/overview.mdx‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
---
2+
title: Dashboard overview
3+
description: Manage your Fern projects, settings, and team from a central dashboard.
4+
---
5+
6+
The Fern Dashboard provides a central place to manage your projects, team members, and settings.
7+
8+
## Setup
9+
10+
Visit your team's [Dashboard](https://dashboard.buildwithfern.com/) and complete initial setup steps:
11+
12+
<CardGroup cols={3}>
13+
<Card
14+
title="Add team members"
15+
icon="regular users"
16+
href="/learn/dashboard/permissions"
17+
>
18+
Add team members and assign roles to control their access levels.
19+
</Card>
20+
<Card
21+
title="Integrate GitHub"
22+
icon="brands github"
23+
>
24+
Connect your GitHub repository to your project.
25+
</Card>
26+
<Card
27+
title="Enable Ask Fern"
28+
icon="regular message-bot"
29+
>
30+
Set up AI-powered chat for your documentation.
31+
</Card>
32+
</CardGroup>
33+
34+
## Ongoing usage
35+
36+
Once you've completed initial setup tasks, use your dashboard to monitor and manage your documentation:
37+
38+
<CardGroup cols={3}>
39+
<Card
40+
title="Site information"
41+
icon="regular info-circle"
42+
>
43+
View deployment status, domains, CLI version, and GitHub repo details.
44+
</Card>
45+
<Card
46+
title="Web analytics"
47+
icon="regular chart-line"
48+
>
49+
Track how developers and bots interact with your documentation.
50+
</Card>
51+
<Card
52+
title="Search analytics"
53+
icon="regular magnifying-glass"
54+
>
55+
Monitor search queries to understand what developers are looking for in your docs.
56+
</Card>
57+
<Card
58+
title="Feedback"
59+
icon="regular comment-dots"
60+
href="/learn/docs/user-feedback"
61+
>
62+
View and respond to on-page feedback.
63+
<p className="text-(color:--grayscale-a11) font-bold mt-2 flex items-center gap-1">
64+
Learn more
65+
66+
<img src="https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-09-30T17:39:54.370Z/products/home/pages/images/arrow-right-black.svg" alt="Arrow right light" className="arrow-right dark:hidden m-0 h-4 w-4" noZoom />
67+
68+
<img src="https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-09-30T17:39:54.370Z/products/home/pages/images/arrow-right-white.svg" alt="Arrow right light" className="arrow-right hidden dark:block m-0 h-4 w-4" noZoom />
69+
</p>
70+
71+
</Card>
72+
<Card
73+
title="Ask Fern conversations"
74+
icon="regular messages"
75+
href="/learn/ask-fern/getting-started/what-is-ask-fern"
76+
>
77+
Review AI chat conversation history.
78+
<p className="text-(color:--grayscale-a11) font-bold mt-2 flex items-center gap-1">
79+
Learn more
80+
81+
<img src="https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-09-30T17:39:54.370Z/products/home/pages/images/arrow-right-black.svg" alt="Arrow right light" className="arrow-right dark:hidden m-0 h-4 w-4" noZoom />
82+
83+
<img src="https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-09-30T17:39:54.370Z/products/home/pages/images/arrow-right-white.svg" alt="Arrow right light" className="arrow-right hidden dark:block m-0 h-4 w-4" noZoom />
84+
</p>
85+
86+
</Card>
87+
<Card
88+
title="Fern Editor"
89+
icon="regular pen-to-square"
90+
href="/learn/docs/writing-content/fern-editor"
91+
>
92+
Create and manage Fern Editor sessions.
93+
<p className="text-(color:--grayscale-a11) font-bold mt-2 flex items-center gap-1">
94+
Learn more
95+
96+
<img src="https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-09-30T17:39:54.370Z/products/home/pages/images/arrow-right-black.svg" alt="Arrow right light" className="arrow-right dark:hidden m-0 h-4 w-4" noZoom />
97+
98+
<img src="https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-09-30T17:39:54.370Z/products/home/pages/images/arrow-right-white.svg" alt="Arrow right light" className="arrow-right hidden dark:block m-0 h-4 w-4" noZoom />
99+
</p>
100+
101+
</Card>
102+
</CardGroup>
103+

‎fern/products/dashboard/pages/permissions.mdx‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Member permissions
3+
description: Manage team member roles and access levels in your organization.
4+
---
5+
6+
Use the Fern Dashboard to assign roles to your teammates.
7+
8+
<Info title="Coming soon">
9+
Member permissions are in active development. Reach out via Slack or [email protected] for more information.
10+
</Info>
11+
12+
## Role types
13+
14+
Member roles control what actions someone can take in your organization, such as managing settings, viewing analytics, and publishing to production. [**CLI access**](/learn/cli-api-reference/cli-reference/overview) determines who can publish SDKs and documentation sites to production (local development doesn't require it).
15+
16+
### Admin
17+
18+
Admins have full administrative access to your Fern organization and full CLI access. They can:
19+
20+
- Manage members, including adding and removing roles.
21+
- Publish SDKs and documentation sites to production.
22+
23+
### Editor
24+
25+
Editors can work with SDKs and documentation, but can't edit Fern organization settings or manage members. CLI access is enabled or disabled per Editor:
26+
27+
- Editors **with** CLI access can publish SDKs and documentation sites to production.
28+
- Editors **without** CLI access can't publish to production.
29+
30+
### Viewer
31+
32+
Viewers have read-only access to the Dashboard and analytics. They can't edit organization settings, manage members, or publish to production.
33+
34+
## Permissions by role
35+
36+
| Permission | Admin | Editor | Viewer |
37+
|------------|-------|--------|--------|
38+
| Manage organization settings | ✅ | ❌ | ❌ |
39+
| Manage members | ✅ | ❌ | ❌ |
40+
| Publish to production | ✅ | Configure per Editor | ❌ |
41+
| Generate locally | ✅ | ✅ | ✅ |
42+
| View dashboard and analytics | ✅ | ✅ | ✅ |

‎fern/products/dashboard/pages/sso.mdx‎

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
---
2+
title: Set up Single Sign-On (SSO)
3+
description: Let teammates sign in to Fern with your IdP (SAML or OIDC)
4+
---
5+
6+
<Markdown src="/snippets/enterprise-plan.mdx" />
7+
8+
Set up Single Sign-On (SSO) to sign in to Fern using the identity provider you already use. SSO setup requires coordination with Fern: you'll need configuration values from Fern (like callback URLs and entity IDs) to set up your IdP, and you'll share your IdP metadata back with Fern to complete the connection.
9+
10+
Choose SAML or OIDC depending on your IdP, then follow the steps below for Okta, Google Workspace, or Microsoft Entra.
11+
12+
<Note title="Using another provider?">
13+
If you use another IdP, Fern will help you configure it. Reach out via Slack or [email protected] to get started.
14+
</Note >
15+
16+
## Okta
17+
18+
<Tabs>
19+
<Tab title="SAML">
20+
<Steps>
21+
<Step title="Receive configuration values from Fern">
22+
Fern will send you the SSO URL and Audience URI through a secure channel (not Slack/email).
23+
</Step>
24+
25+
<Step title="Create and configure application in Okta">
26+
In **Applications**, create a new app integration using **SAML 2.0**. Configure with these values:
27+
28+
| Field | Value |
29+
| ----- | ----- |
30+
| Single sign-on URL | [value from Fern] |
31+
| Audience URI | [value from Fern] |
32+
| Name ID format | `EmailAddress` |
33+
34+
Then, add attribute statements:
35+
| Name | Value |
36+
| ------ | -------------------------------------- |
37+
| `name` | `user.firstName + " " + user.lastName` |
38+
| `email`| `user.email` |
39+
</Step>
40+
41+
<Step title="Send Fern your IdP metadata">
42+
From the **Sign-On** tab, copy the Metadata URL and X.509 certificate. Send them back to Fern. Fern will enable the connection and run a test login with you.
43+
</Step>
44+
45+
<Step title="Disable IdP-initiated login">
46+
In the **General** tab under **App visibility**, enable **Do not display application icon to users**. This prevents IdP-initiated login flows, which carry security risks.
47+
</Step>
48+
49+
<Step title="Assign users">
50+
Assign the people who should access Fern.
51+
</Step>
52+
</Steps>
53+
</Tab>
54+
55+
<Tab title="OIDC">
56+
<Steps>
57+
<Step title="Receive configuration values from Fern">
58+
Fern will send you the Redirect URI through a secure channel (not Slack/email).
59+
</Step>
60+
61+
<Step title="Create and configure application in Okta">
62+
In **Applications**, create a new **Web Application** using OIDC. Use Authorization Code grant and set the Redirect URI to the value Fern provided.
63+
</Step>
64+
65+
<Step title="Send Fern your IdP credentials">
66+
Share the Client ID, Client Secret, and your Okta domain (e.g., `<your-tenant>.okta.com`) back to Fern. Fern will enable the connection and run a test login with you.
67+
</Step>
68+
69+
<Step title="Disable IdP-initiated login">
70+
In the **General** tab under **App visibility**, enable **Do not display application icon to users**. This prevents IdP-initiated login flows, which carry security risks.
71+
</Step>
72+
73+
<Step title="Assign users">
74+
Assign the people who should access Fern.
75+
</Step>
76+
</Steps>
77+
</Tab>
78+
</Tabs>
79+
80+
## Google Workspace
81+
82+
<Tabs>
83+
<Tab title="SAML">
84+
<Steps>
85+
<Step title="Receive configuration values from Fern">
86+
Fern will send you the ACS URL and Entity ID through a secure channel (not Slack/email).
87+
</Step>
88+
89+
<Step title="Create and configure application in Google">
90+
In **Web and mobile apps**, choose **Add app → Add custom SAML app**. On **Service provider details**, enter these values:
91+
92+
| Field | Value |
93+
| ----- | ----- |
94+
| ACS URL | [value from Fern] |
95+
| Entity ID | [value from Fern] |
96+
| Name ID format | `EMAIL` |
97+
| Name ID | `Primary email` |
98+
99+
Then, add attribute statements:
100+
| Google Directory Attribute | App Attribute |
101+
| -------------------------- | ------------- |
102+
| `First name` | `firstName` |
103+
| `Last name` | `lastName` |
104+
</Step>
105+
106+
<Step title="Send Fern your IdP metadata">
107+
Copy the SSO URL, Entity ID, and X.509 certificate from Google. Send them to Fern. Fern will enable the connection and run a test login with you.
108+
</Step>
109+
110+
<Step title="Assign users">
111+
Assign the people who should access Fern.
112+
</Step>
113+
</Steps>
114+
</Tab>
115+
</Tabs>
116+
117+
## Microsoft Entra
118+
119+
<Tabs>
120+
<Tab title="SAML">
121+
<Steps>
122+
<Step title="Create an application">
123+
Under **Enterprise applications**, select **New application → Create your own application → Non-gallery**.
124+
</Step>
125+
126+
<Step title="Receive configuration values from Fern">
127+
Fern will send you the Identifier (Entity ID) and Reply URL (ACS) through a secure channel.
128+
</Step>
129+
130+
<Step title="Configure SAML">
131+
In **Single Sign-On**, choose **SAML** and enter these values:
132+
133+
| Field | Value |
134+
| ----- | ----- |
135+
| Identifier (Entity ID) | [value from Fern] |
136+
| Reply URL (ACS) | [value from Fern] |
137+
| Name ID | `user.primaryauthoritativeemail` (email) |
138+
139+
Then, add attribute statements:
140+
141+
| Name | Value |
142+
| ----------- | ---------------- |
143+
| `firstName` | `user.givenname` |
144+
| `lastName` | `user.surname` |
145+
</Step>
146+
147+
<Step title="Send Fern your IdP metadata">
148+
From **SAML Certificates**, copy the **App Federation Metadata URL**. Send it to Fern. Fern will enable the connection and run a test login with you.
149+
</Step>
150+
151+
<Step title="Disable IdP-initiated login">
152+
To prevent IdP-initiated login flows (which carry security risks), do not distribute the User access URL.
153+
154+
Optionally, create a Conditional Access policy to block sign-ins that don't originate from your service provider.
155+
</Step>
156+
157+
<Step title="Assign users">
158+
In **Users and groups**, add the people who should access Fern.
159+
</Step>
160+
</Steps>
161+
</Tab>
162+
</Tabs>

0 commit comments

Comments
 (0)