fern icon indicating copy to clipboard operation
fern copied to clipboard

Update overrides.mdx

Open dannysheridan opened this issue 1 year ago • 9 comments

  • Improves the slug of overrides
  • Removes slugs from the OpenAPI section in docs.yml and puts them in each page's frontmatter (cleaner IMO)

dannysheridan avatar Jun 18 '24 13:06 dannysheridan

🌿 Preview your docs: https://fern-preview-4ab14bf8-55dd-4c2f-abd5-8b540813f056.docs.buildwithfern.com

github-actions[bot] avatar Jun 18 '24 13:06 github-actions[bot]

🌿 Preview your docs: https://fern-preview-57c2cedb-f571-4277-b0b4-0a7118fe1875.docs.buildwithfern.com

github-actions[bot] avatar Jun 18 '24 13:06 github-actions[bot]

🌿 Preview your docs: https://fern-preview-e8b7defd-b2a4-4b3a-b4c1-1703a54fe83e.docs.buildwithfern.com

github-actions[bot] avatar Jun 18 '24 13:06 github-actions[bot]

🌿 Preview your docs: https://fern-preview-6ce158c5-134d-4fa8-875e-e7a854cbf782.docs.buildwithfern.com

github-actions[bot] avatar Jun 18 '24 13:06 github-actions[bot]

@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

dannysheridan avatar Jun 18 '24 13:06 dannysheridan

🌿 Preview your docs: https://fern-preview-fa0002ec-3b33-4a8c-bf09-e02552c63f93.docs.buildwithfern.com

github-actions[bot] avatar Jun 18 '24 14:06 github-actions[bot]

@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?

chdeskur avatar Jun 18 '24 14:06 chdeskur

Let's do 2 pages. Want to make it happen?

dannysheridan avatar Jun 18 '24 16:06 dannysheridan

I can tackle this after the Syndicate migration

chdeskur avatar Jun 18 '24 17:06 chdeskur