Skip to content

improvement(docs): streamline API reference navigation - #7383

Merged
waleedlatif1 merged 1 commit into
stagingfrom
codex/collapse-api-reference-sidebar
Sep 2, 2026
Merged

improvement(docs): streamline API reference navigation#7383
waleedlatif1 merged 1 commit into
stagingfrom
codex/collapse-api-reference-sidebar

Conversation

@waleedlatif1

Copy link
Copy Markdown
Collaborator

Summary

  • Collapse API endpoint groups by default while keeping the active group expanded
  • Add a downloadable OpenAPI 3.1 JSON specification to Getting Started

Type of Change

  • Improvement

Testing

  • Tested manually in the docs UI
  • bun run lint
  • bun run lint:check
  • bun run check:audits
  • bun run check:openapi
  • bun run --cwd apps/docs test --run lib/openapi-download.test.ts lib/openapi-source.test.ts
  • bun run --cwd apps/docs type-check

Checklist

  • Code follows project style guidelines
  • Self-reviewed my changes
  • Tests added/updated and passing
  • No new warnings introduced
  • I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

@vercel

vercel Bot commented Sep 2, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Sep 2, 2026 2:16am UTC

Request Review

@greptile-apps

greptile-apps Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

The PR streamlines API-reference navigation and adds a downloadable, consolidated OpenAPI 3.1 document.

  • Keeps only the active sidebar folder expanded by default and exposes expansion state to assistive technology.
  • Merges the domain-specific API specifications into a single downloadable JSON document.
  • Links the downloadable specification from the API Getting Started guide and adds focused tests.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
apps/docs/app/openapi.json/route.ts Adds the static docs-local endpoint that serves the consolidated OpenAPI document as a named JSON download.
apps/docs/lib/openapi-download.ts Validates and combines domain specifications while namespacing component references and rejecting conflicting definitions.
apps/docs/components/docs-layout/sidebar-components.tsx Collapses inactive API-reference groups by default and adds accessible expansion state.
apps/docs/content/docs/api-reference/getting-started.mdx Documents the downloadable OpenAPI 3.1 specification.
apps/docs/lib/openapi-download.test.ts Verifies merged paths, tags, local references, response content type, and download filename.

Reviews (2): Last reviewed commit: "improvement(docs): streamline API refere..." | Re-trigger Greptile

Comment thread apps/docs/app/openapi.json/route.ts

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No issues found across 5 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Re-trigger cubic

@waleedlatif1

Copy link
Copy Markdown
Collaborator Author

@greptile

@waleedlatif1

Copy link
Copy Markdown
Collaborator Author

@cubic-dev-ai review this PR

@cubic-dev-ai

cubic-dev-ai Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

@cubic-dev-ai review this PR

@waleedlatif1 I have started the AI code review. It will take a few minutes to complete.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No issues found across 5 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Re-trigger cubic

@waleedlatif1
waleedlatif1 merged commit 47c0805 into staging Sep 2, 2026
29 checks passed
@waleedlatif1
waleedlatif1 deleted the codex/collapse-api-reference-sidebar branch September 2, 2026 03:22
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.

1 participant