Skip to content

Clarify how Docs/API Reference uses generators.yml #585

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 25, 2025
Merged

Clarify how Docs/API Reference uses generators.yml #585

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77158d4
add new page
devalog Aug 25, 2025
bd213b0
add info about using generators.yml for docs
devalog Aug 25, 2025
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
4 changes: 4 additions & 0 deletions fern/products/docs/pages/api-references/sdk-snippets.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,10 @@ navigation:
```
</CodeBlock>

<Note>
To display different package names for SDK users versus documentation users, [use overrides files](/api-definitions/overview/overrides#separate-overrides-for-sdks-and-docs).
</Note>

### Trigger generation

As the final step, trigger your docs generation by running `fern generate --docs` locally or in CI/CD (i.e., GitHub Actions). The SDK snippets will now appear via a drop-down!
Expand Down
16 changes: 15 additions & 1 deletion fern/products/docs/pages/getting-started/project-structure.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,18 @@ title: Fern's Documentation
</Accordion>
</AccordionGroup>

<Note>
If you're using Fern for both API Reference documentation and SDKs, you'll use both `docs.yml` (the Docs configuration file) and `generators.yml` ([the SDK configuration file](/sdks/overview/github#generatorsyml)) to configure [how SDK code snippets appear](/docs/api-references/sdk-snippets) in your API reference documentation.

If you're only using Fern for API Reference docs, not SDKs, your `generators.yml` should simply link to your spec:

```yaml title="generators.yml"
api:
specs:
- openapi: ../openapi/openapi.json
```
</Note>


## `fern.config.json`

Expand All @@ -177,4 +189,6 @@ The `fern.config.json` file specifies your organization name and the version of
"version": "<Markdown src="/products/sdks/snippets/fern-config-json-version.mdx"/>"
}
```
</CodeBlock>
</CodeBlock>