Skip to content

docs: reflect sdk-config.yml and docs.yml specs on Docs project structure - #7704

Merged
nerminamiller-postman merged 1 commit into
mainfrom
devin/1793390928-docs-project-structure-sdk-config
Oct 30, 2026
Merged

nerminamiller-postman merged 1 commit into
mainfrom
devin/1793390928-docs-project-structure-sdk-config

Conversation

@nerminamiller-postman

Copy link
Copy Markdown
Collaborator

Summary

Updates the Docs project structure page (getting-started/project-structure.mdx) for sdk-config.yml and for specs listed in docs.yml. This was split out of #7680, which is held until a feature flag is lifted. This page doesn't depend on that flag.

  • File tree: shows sdk-config.yml (configures SDKs) and generators.yml (references specs). Both are optional.
  • Section rename: "API definitions and generators.yml" is now "API definitions", so its anchor changes. No pages link to the old anchor.
  • Where specs go:
    • Specs can be listed in an api entry's specs in docs.yml. That's what fern init --docs and fern sdk migrate write (CLI 5.157.6).
    • generators.yml api.specs still works.
  • SDKs: they're configured in sdk-config.yml. Projects that haven't migrated still use generators.yml groups.
  • Accordions: the OpenAPI and AsyncAPI accordions show the docs.yml specs form first and the generators.yml form second.

Link to Devin session: https://app.devin.ai/sessions/1c19efb11d3c44dda8c9a87305b621f0
Open in Devin Desktop: https://app.devin.ai/desktop/session/1c19efb11d3c44dda8c9a87305b621f0?variant=devin
Requested by: @nerminamiller-postman

…ture

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor

I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".

  • Disable automatic comment, CI, and merge conflict monitoring

@github-actions

Copy link
Copy Markdown
Contributor

@devin-ai-integration

Copy link
Copy Markdown
Contributor

@nerminamiller-postman
nerminamiller-postman merged commit 3410e11 into main Oct 30, 2026
5 checks passed
@nerminamiller-postman
nerminamiller-postman deleted the devin/1793390928-docs-project-structure-sdk-config branch October 30, 2026 20:44
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.

2 participants