Review only: shared API sidebar source changes#82
Closed
Conversation
Deploying qf-api-docs with
|
| Latest commit: |
fdf7a82
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://db0114e5.qf-api-docs.pages.dev |
| Branch Preview URL: | https://codex-review-shared-api-side.qf-api-docs.pages.dev |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors the Docusaurus/OpenAPI docs navigation to support a shared “Stripe-style” API sidebar (with per-family sidebars still available), and wires a post-generation step to keep generated API docs stable across regenerations.
Changes:
- Refactors
sidebars.jsto build API family trees once and reuse them for both family-specific and shared API sidebars (latest + versioned). - Updates Docusaurus config + homepage links to route API entry points to intro docs that use the shared sidebar and keeps sidebars persistently visible.
- Adds a post-generation script to set
displayed_sidebaron generated OpenAPI MDX and normalize “Foot Note” labels, plus syncsstatic/llms.txt.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
sidebars.js |
Introduces shared API sidebars and consolidates API family sidebar construction/reuse logic. |
docusaurus.config.js |
Adjusts sidebar UX behavior and updates navbar/footer API links to shared intro-doc routes. |
package.json |
Wires a post-generation step into gen-all for sidebar/frontmatter normalization. |
scripts/set-api-displayed-sidebars.js |
New postgen script to set displayed_sidebar on generated MDX and normalize “Foot Note” labels in generated output. |
src/components/HomepageFeatures/index.tsx |
Updates API cards/CTA to route to shared intro-doc entry points. |
static/llms.txt |
Updates a generated label to keep “Footnote” stable. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
osamasayed
requested changes
Mar 28, 2026
Member
osamasayed
left a comment
There was a problem hiding this comment.
@basit3407 it seems selecting versions of Search/OAuth2 APIs lead to broken page:
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Purpose
Review scope
This PR intentionally includes only these six files:
sidebars.jsdocusaurus.config.jspackage.jsonscripts/set-api-displayed-sidebars.jssrc/components/HomepageFeatures/index.tsxstatic/llms.txtImportant
codex/stripe-api-sidebarWhat to review here
sidebars.jsFootnotestable after regenerationIntended workflow
Validation on the full branch
yarn build