Skip to content

Standardize OpenAPI spec references to .yaml across docs #5586

Merged
devalog merged 3 commits into
mainfrom
fern/clarify-yaml-yml-quickstart
May 21, 2026
Merged

Standardize OpenAPI spec references to .yaml across docs #5586
devalog merged 3 commits into
mainfrom
fern/clarify-yaml-yml-quickstart

Conversation

@fern-api
Copy link
Copy Markdown
Contributor

@fern-api fern-api Bot commented May 21, 2026

Summary

Standardizes OpenAPI specification file references from .yml to .yaml across documentation pages for consistency with the project structure page and starter template.

Problem

User feedback reported that the quickstart page mentions openapi.yaml in the starter template file tree but then uses .yml in the fern init command, causing confusion when following along. The same inconsistency appeared across several other pages.

Changes

  • quickstart.mdx: fern init --openapi /path/to/openapi.yml.yaml
  • generate-api-ref.mdx: Config example and file trees updated from openapi.ymlopenapi.yaml
  • generate-webhook-ref.mdx: Config example and file trees updated from openapi.ymlopenapi.yaml
  • commands.mdx: CLI reference example updated from openapi.ymlopenapi.yaml
  • snippets/openapi-specs.mdx: Shared snippet updated from openapi.ymlopenapi.yaml

Fern config files (docs.yml, generators.yml) remain .yml — this change only affects OpenAPI spec file references.

Requested by: Fern Support

@fern-api fern-api Bot requested a review from devalog as a code owner May 21, 2026 15:45
@fern-api
Copy link
Copy Markdown
Contributor Author

fern-api Bot commented May 21, 2026

Requested by: devin
Slack thread: View conversation

@devalog devalog merged commit 134b2e1 into main May 21, 2026
4 checks passed
@devalog devalog deleted the fern/clarify-yaml-yml-quickstart branch May 21, 2026 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant