Add API Reference#253
Open
AHGIJMKLKKZNPJKQR wants to merge 6 commits intomainfrom
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds an unversioned “API Reference” section to the Docusaurus site using the Scalar plugin, and updates docs to include uv installation instructions.
Changes:
- Integrate
@scalar/docusaurusand add a top-level navbar link to/api/rest. - Hide the docs version dropdown when viewing the unversioned API reference.
- Update backend docs (current + versioned) to add
uvtabs and normalize tab labels.
Reviewed changes
Copilot reviewed 13 out of 14 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| yarn.lock | Locks new Scalar + transitive dependencies. |
| package.json | Adds Scalar plugin (and @docusaurus/utils) dependencies. |
| docusaurus.config.ts | Configures Scalar plugin route and adds “Docs”/“API Reference” navbar items. |
| src/theme/NavbarItem/index.tsx | Wraps navbar items to hide the version dropdown on the API reference route. |
| src/css/custom.css | Tweaks Scalar page typography/badges to better match site styling. |
| docs/api/reference.md | Updates reference page to link to the new REST API reference route. |
| docs/how-to/backend/server-setup.mdx | Normalizes package-manager tab labels and adds uv install instructions. |
| docs/tutorials/backend-quick-start.mdx | Adds uv install instructions for Python dependencies. |
| versioned_docs/version-0.24.0/tutorials/backend-quick-start.mdx | Adds uv install instructions (v0.24.0). |
| versioned_docs/version-0.24.0/how-to/backend/server-setup.mdx | Normalizes tab labels + adds uv (v0.24.0). |
| versioned_docs/version-0.25.0/tutorials/backend-quick-start.mdx | Adds uv install instructions (v0.25.0). |
| versioned_docs/version-0.25.0/how-to/backend/server-setup.mdx | Normalizes tab labels + adds uv (v0.25.0). |
| versioned_docs/version-0.26.0/tutorials/backend-quick-start.mdx | Adds uv install instructions (v0.26.0). |
| versioned_docs/version-0.26.0/how-to/backend/server-setup.mdx | Normalizes tab labels + adds uv (v0.26.0). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Description
Long awaited API viewer, using Scalar docusaurus plugin.
The API reference isn't versioned, since there is only 1 version of the HTTP API