Docs: Re-architect Authentication section (dedupe API key injection; flatten API Explorer) #3591
Conversation
…entication, flatten API Explorer, deduplicate RBAC
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| ### Deploy to hosting platform | ||
|
|
||
| The processed content is deployed to Vercel as a documentation site with an embedded [API explorer](/learn/docs/api-references/api-explorer/overview) that allows users to test endpoints directly within the documentation. | ||
| The processed content is deployed to Vercel as a documentation site with an embedded [API explorer](/learn/docs/api-references/api-explorer) that allows users to test endpoints directly within the documentation. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[FernStyles.Reject] Use 'API Explorer' instead of 'API explorer'.
| You can restrict specific content within your MDX pages to users with certain roles. This allows you to show different content to different user types on the same page. | ||
|
|
||
| #### Basic usage | ||
| ### In MDX pages |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'In MDX pages' should use sentence-style capitalization.
|
|
||
| - **Use the Fern Editor**: Make edits to your docs from the browser | ||
| - **Send Authenticated Preview Links** Only authenticated users can view [preview links](/learn/docs/preview-publish/preview-changes#preview-links) | ||
| <Note>SSO provides login-based access control but does not support role management or API key injection. For granular access control, use [RBAC](/learn/docs/authentication/rbac) instead.</Note> |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.
|
|
||
| ### Advanced payload configuration | ||
|
|
||
| With [JWT setup](/learn/docs/authentication/setup/jwt), you have full control over the `fern.playground` payload. These options let you go beyond a single bearer token — pre-filling custom headers, supporting multiple API keys, or varying credentials by environment. These options are not available with OAuth, where Fern manages the token. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'aren't' instead of 'are not'.
| </Card> | ||
| </CardGroup> | ||
|
|
||
| ## Which option should I use? |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.FirstPerson] Use first person (such as ' I') sparingly.
| </Card> | ||
| </CardGroup> | ||
|
|
||
| ## Which option should I use? |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.HeadingPunctuation] Don't use end punctuation in headings.
|
|
||
| - **Use the Fern Editor**: Make edits to your docs from the browser | ||
| - **Send Authenticated Preview Links** Only authenticated users can view [preview links](/learn/docs/preview-publish/preview-changes#preview-links) | ||
| <Note>SSO provides login-based access control but does not support role management or API key injection. For granular access control, use [RBAC](/learn/docs/authentication/features/rbac) instead.</Note> |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.
1 participant
No description provided.