Document a collection with Fern
When you publish a Postman Collection with Fern, Fern automatically generates your API reference documentation from your collection. Your site is deployed live, and you can manage it from the Fern Dashboard.
From there, you can add guides, overview pages, tutorials, and other content alongside your API reference to build a complete documentation site.
If your team has public workspaces, Postman might have already generated a Fern Docs site for your team. If it has, that site takes precedence in the Fern tab in Postman, and Team Admins can claim it instead of publishing a new one.
Claim your team’s Fern Docs site
Postman generates a Fern Docs site for teams on any plan, including Team and Enterprise, from the team’s public workspaces. The site covers your whole team, not a single collection. It includes a welcome page, a quickstart, and an API Reference built from your public collections. The site is already live at <team-name>.docs.buildwithfern.com, so you can view it before you claim it.
When you claim the site, you become its admin in Fern and can customize and publish it as your own. Claiming applies to your whole team, so you only need to claim once, from any collection.
The site syncs with your public collections once every 24 hours, before and after you claim it.
Only Team Admins can claim your team’s Fern Docs site. Other team members see View Fern Docs, which opens the site.
To claim your team’s Fern Docs site, do the following:
- In the sidebar, click
Items, then expand Collections and select a collection.
- In the collection’s Overview tab, click
Publish docs. The Fern tab opens.
- (Optional) Click View docs to review the site before you claim it.
- Click Claim docs. A new browser tab opens.
- If prompted, sign in with the same Postman account you used to click Claim docs.
- When you see Docs claimed successfully, return to Postman. You can close the browser tab. The Fern tab in Postman updates to show your site.

After you claim the site, the Fern tab shows your site’s URL along with Edit styling, View dashboard, and Settings. To learn more, see Manage your Fern documentation. To give your teammates access in Fern, invite them from the Fern Dashboard.
Troubleshoot claiming
Publish a collection with Fern
If your team doesn’t have a generated Fern Docs site, you can publish a collection with Fern yourself. If your team does have one, the Fern tab shows that site instead of the Get started option, so claim it instead. To publish your collection documentation with Fern, do the following:
-
In the sidebar, click
Items, then expand Collections and select a collection.
-
In the collection’s Overview tab in the workbench, click View complete documentation.
-
Click
Publish docs, select Fern, then click Get started.

-
Configure your documentation site:
- Site name — Enter a name for your documentation site.
- Primary color — Select a primary color scheme for your site’s branding.
- Logo — Upload a logo for your site, or paste a URL (like a marketing site or blog), and Fern automatically extracts your brand information. If you’ve previously published documentation with Postman, your existing logo and color scheme are imported automatically.
-
Click Publish. Your documentation is published to a GitHub repository that your team owns and deployed live onto a new documentation site. You can modify all of these settings later.
Each collection can only be published once through Fern. If you try to publish a collection already published by another team member, you’ll receive an error.
View your published documentation
After Fern publishes your site, your documentation is deployed live. You can edit the documentation, navigate to your live site URL, or share with your team.

To view your published documentation from your collection, do the following:
- In the sidebar, click
Items, then expand Collections and select a published collection.
- Click
Docs published, then click the link to open your live documentation site.
What teammates see
Team members who aren’t admins, and people outside your team, see View Fern Docs on your collection, which opens your live site. To give a teammate access to edit the site in Fern, invite them from the Members page in the Fern Dashboard.
Keep your documentation up to date
Your Fern Docs site syncs with your collection once every 24 hours. The Fern tab shows Fern up-to-date when your published site matches your collection.
Unpublish your documentation
If you no longer want your documentation to be publicly available, you can unpublish it.
- In the sidebar, click
Items, then expand Collections and select a published collection.
- Click
Docs published, then click
Unpublish to unpublish your docs with Fern. Your auto-generated documentation in Postman won’t be affected.
If you claimed your team’s Fern Docs site, unpublish it from the Fern Dashboard instead. Click Settings on the Fern tab, then use Unpublish site.
Manage your Fern documentation
After you publish a collection or claim your team’s site, you can manage it from the Fern tab in Postman. The tab works the same way for both:
- Edit styling — Change your site’s branding in the Fern Dashboard.
- View dashboard — Open your site in the Fern Dashboard.
- Settings — Open your site’s settings in the Fern Dashboard, such as authentication, Ask AI, query log retention, and the option to unpublish the site.

The Fern Dashboard provides a central place to manage your projects, team members, and settings. You have full edit rights and ownership of your documentation.

You can configure the following features and settings in the Fern Dashboard:
- Set up custom domain — Configure your custom domain with automatic DNS record provisioning.
- Member permissions — Assign Admin, Editor, or Viewer roles to manage Dashboard and CLI access.
- Integrate GitHub — Connect your GitHub repository to your project.
- Enable Ask Fern — Set up AI-powered chat for your documentation.
- View web analytics — Track how developers and bots interact with your documentation.
- Manage site information — View deployment status, domains, CLI version, and GitHub repo details.
Edit published documentation
After Fern generates your API reference, you can edit your documentation to add guides, overview pages, tutorials, and other content alongside it.
To edit documentation you published from a collection, do the following:
- In the sidebar, click
Items, then expand Collections and select a published collection.
- Click
Docs published, then click
Edit published documentation. You can make a PR and edit in your code environment. Alternatively, you can edit using Fern Editor, a browser-based editor backed by GitHub.
If you claimed your team’s Fern Docs site, click View dashboard on the Fern tab, then use the Editor tab in the Fern Dashboard.
You can preview changes in your local development environment and publish them to production when you’re ready using the Fern CLI.