improvement(docs): streamline API reference navigation - #7383
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
Greptile SummaryThe PR streamlines API-reference navigation and adds a downloadable, consolidated OpenAPI 3.1 document.
Confidence Score: 5/5The PR appears safe to merge. No blocking failure remains.
|
| 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
Collaborator
Author
Collaborator
Author
|
@cubic-dev-ai review this PR |
Contributor
@waleedlatif1 I have started the AI code review. It will take a few minutes to complete. |
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.
Summary
Type of Change
Testing
Checklist