Skip to content

docs: scalar API docs demo#795

Open
brad-dow wants to merge 4 commits into
mainfrom
bd/scalar-api-reference
Open

docs: scalar API docs demo#795
brad-dow wants to merge 4 commits into
mainfrom
bd/scalar-api-reference

Conversation

@brad-dow
Copy link
Copy Markdown
Contributor

Description of changes

  • Removes starlight-openapi plugin and replaces it with three standalone Astro pages at /apis/{server}/ powered by Scalar
  • Scalar links open in a new tab
  • Adds a custom header matching the Starlight theme, with dark/light mode sync and a link back to documentation
  • Updates all internal API reference links across SDK pages, guides, and concepts to use Scalar's deep link format so links land directly on the relevant endpoint/operation
  • Converts absolute links to relative paths on the guides' "Endpoints" section

Checklist

  • PR title is prefixed with docs:
  • PR title or description includes a fixes #
  • You've run pnpm format and pnpm lint
  • You've reviewed Vale errors and made changes where appropriate

brad-dow added 3 commits May 20, 2026 17:48
Removes the starlight-openapi plugin and replaces it with three standalone
Astro pages at /apis/{server}/ that load the Scalar API reference UI via CDN.
Includes a custom sticky header matching the Starlight teal theme, dark/light
mode sync with Starlight's localStorage key, and external-link sidebar items.
Removes dead starlight-openapi CSS from openpayments.css.
Updates all internal links to API operations across SDK pages, guides,
and concept pages (English and Spanish) to use Scalar's deep link format
(#tag/{tag}/{METHOD}/{path}) so links land directly on the relevant
operation rather than the top of the page.
@netlify
Copy link
Copy Markdown

netlify Bot commented May 21, 2026

Deploy Preview for openpayments ready!

Name Link
🔨 Latest commit 958bc47
🔍 Latest deploy log https://app.netlify.com/projects/openpayments/deploys/6a0f5a916795400008af9bca
😎 Deploy Preview https://deploy-preview-795--openpayments.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant