docs: add coverage for customer FAQ topics#4340
Merged
Merged
Conversation
- Clarify Git repo ownership after self-service setup - Add plan availability and spec storage guidance to OpenAPI sync page - Update Postman integration page with publish-to-Fern flow - Document no limit on RBAC roles Co-Authored-By: bot_apk <apk@cognition.ai>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
Requested by: kapil |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| <Markdown src="/snippets/agent-directive.mdx"/> | ||
|
|
||
| Automatically pull your latest OpenAPI spec from a publicly available URL into your fern folder using the [sync-openapi GitHub Action](https://github.com/fern-api/sync-openapi). This keeps your committed spec in sync with your live API without manual updates. | ||
| Automatically pull your latest OpenAPI spec from a publicly available URL into your fern folder using the [sync-openapi GitHub Action](https://github.com/fern-api/sync-openapi). This keeps your committed spec in sync with your live API without manual updates. The sync-openapi action and the `fern api update` CLI command are available on all [plans](https://buildwithfern.com/pricing). |
Contributor
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'latest' that become outdated
Contributor
|
🌿 Preview your docs: https://fern-preview-cef50f4a-2068-4430-8847-5fa01edd990c.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
| Fern's Postman integration is no longer actively maintained. To get your API endpoints into Postman, import your OpenAPI specification directly. See [Postman's OpenAPI import docs](https://learning.postman.com/docs/integrations/available-integrations/working-with-openAPI/) for instructions. | ||
| ## Publish Postman collections to Fern | ||
|
|
||
| You can generate a Fern Docs site directly from your Postman collection. Fern automatically creates an API reference from your collection with request details, sample code, and an interactive API explorer. You can also add guides, tutorials, and other content alongside the reference, and customize branding such as your domain, logo, and colors. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[FernStyles.Reject] Use 'API Reference' instead of 'API reference'.
| Fern's Postman integration is no longer actively maintained. To get your API endpoints into Postman, import your OpenAPI specification directly. See [Postman's OpenAPI import docs](https://learning.postman.com/docs/integrations/available-integrations/working-with-openAPI/) for instructions. | ||
| ## Publish Postman collections to Fern | ||
|
|
||
| You can generate a Fern Docs site directly from your Postman collection. Fern automatically creates an API reference from your collection with request details, sample code, and an interactive API explorer. You can also add guides, tutorials, and other content alongside the reference, and customize branding such as your domain, logo, and colors. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[FernStyles.Reject] Use 'API Explorer' instead of 'API explorer'.
| Fern's Postman integration is no longer actively maintained. To get your API endpoints into Postman, import your OpenAPI specification directly. See [Postman's OpenAPI import docs](https://learning.postman.com/docs/integrations/available-integrations/working-with-openAPI/) for instructions. | ||
| ## Publish Postman collections to Fern | ||
|
|
||
| You can generate a Fern Docs site directly from your Postman collection. Fern automatically creates an API reference from your collection with request details, sample code, and an interactive API Explorer. You can also add guides, tutorials, and other content alongside the reference, and customize branding such as your domain, logo, and colors. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[FernStyles.Reject] Use 'API Reference' instead of 'API reference'.
devalog
approved these changes
Mar 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds documentation coverage for five frequently asked customer questions identified from support conversations. Changes span five files across four topic areas:
Self-service setup — repo ownership (
self-service-setup.mdx): Clarifies that after the self-service setup flow, users have full ownership of the Git repo and can publish changes by pushing to main.OpenAPI sync — plan availability & spec storage (
automation.mdx): Notes that the sync-openapi action andfern api updateare available on all plans. Adds a new "Where to store your OpenAPI spec" section describing the three common approaches (sync from source repo, host at public URL, commit directly).Postman integration (
postman.mdx,overview.mdx): Replaces the deprecated-only page with a new section documenting the Postman publish-to-Fern integration (available on all plans), including Postman free-tier and Fern org limits. Retains the deprecated Fern-to-Postman generator info below. Removes "(deprecated)" label from the integrations overview card.RBAC role limits (
rbac.mdx): Adds a sentence clarifying there is no limit on the number of roles.Review & Testing Checklist for Human
#setup,/cli-api-reference/cli-reference/commands#fern-api-update,/learn/sdks/reference/generators-yml#openapi.Notes
automation.mdx(lines 3, 8 — "latest") andrbac.mdx(line 65 — heading casing) were not introduced by this PR and were left as-is.sso.mdxand did not require changes.Link to Devin session: https://app.devin.ai/sessions/91608547945b460c83f817b12c377b2c