Skip to content

Review only: shared API sidebar source changes#82

Closed
basit3407 wants to merge 1 commit intomainfrom
codex/review-shared-api-sidebar
Closed

Review only: shared API sidebar source changes#82
basit3407 wants to merge 1 commit intomainfrom
codex/review-shared-api-sidebar

Conversation

@basit3407
Copy link
Copy Markdown
Collaborator

Purpose

  • review only the handwritten source changes for the shared Stripe-style API sidebar
  • keep generated API MDX and other generated output out of the review surface

Review scope

This PR intentionally includes only these six files:

  • sidebars.js
  • docusaurus.config.js
  • package.json
  • scripts/set-api-displayed-sidebars.js
  • src/components/HomepageFeatures/index.tsx
  • static/llms.txt

Important

What to review here

  • shared API sidebar structure and reuse logic in sidebars.js
  • Docusaurus config changes for persistent sidebar behavior and API entry routes
  • build/generation wiring for the post-generation sidebar patch step
  • homepage API card routing changes
  • the small generated-label normalization that keeps Footnote stable after regeneration

Intended workflow

  1. review and discuss the source changes in this PR
  2. apply any feedback to the real implementation branch as needed
  3. merge PR Implement a shared API sidebar and stabilize generated API navigation #81 for the actual production change
  4. close this review-only PR after the real PR is merged

Validation on the full branch

  • yarn build
@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying qf-api-docs with  Cloudflare Pages  Cloudflare Pages

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

View logs

@basit3407 basit3407 changed the title Review only: shared Stripe-style API sidebar source changes Mar 28, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.js to 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_sidebar on generated OpenAPI MDX and normalize “Foot Note” labels, plus syncs static/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.

Comment thread sidebars.js
@quran quran deleted a comment from osamasayed Mar 28, 2026
@basit3407 basit3407 requested a review from osamasayed March 28, 2026 18:14
Copy link
Copy Markdown
Member

@osamasayed osamasayed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@basit3407 it seems selecting versions of Search/OAuth2 APIs lead to broken page:

Mar-29-2026 12-53-44 am

@basit3407 basit3407 closed this Mar 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

3 participants