Open dannysheridan opened 2 weeks ago
🌿 Preview your docs: https://fern-preview-4ab14bf8-55dd-4c2f-abd5-8b540813f056.docs.buildwithfern.com
🌿 Preview your docs: https://fern-preview-57c2cedb-f571-4277-b0b4-0a7118fe1875.docs.buildwithfern.com
🌿 Preview your docs: https://fern-preview-e8b7defd-b2a4-4b3a-b4c1-1703a54fe83e.docs.buildwithfern.com
🌿 Preview your docs: https://fern-preview-6ce158c5-134d-4fa8-875e-e7a854cbf782.docs.buildwithfern.com
@chdeskur do you think we should
A/ split out OpenAPI extensions into two pages: Docs and SDKs? B/ change the page title to include both?
This is for Docs, but the title says SDKs:
api-definition/openapi/extensions-sdks#audiences-for-docs
🌿 Preview your docs: https://fern-preview-fa0002ec-3b33-4a8c-bf09-e02552c63f93.docs.buildwithfern.com
@dannysheridan
Two pages: Pros: Someone developing SDKs doesn't have to navigate off the SDK tab to learn, can highlight specific information (display-name: relevant for Docs but not so much for SDKs) Cons: Might have a lot of duplicated information, people developing both might feel like they're jumping around a lot
One page, different title: Pros: Avoid duplicating information, have one source of truth for all-things-overrides. If the page is titled well, it shouldn't be that hard to find/search for. Cons: The page is already quite long. I notice a lot of questions we get are often buried somewhere on this page. Might be hard for someone developing SDKs to find overrides information?
Based on this, I might lean towards two pages. Thoughts?
Let's do 2 pages. Want to make it happen?
I can tackle this after the Syndicate migration
docs.yml
and puts them in each page's frontmatter (cleaner IMO)