Skip to content

docs: add PoC API reference at /docs/api-reference-preview using Scalar#4845

Open
philip wants to merge 7 commits into
mainfrom
api-doc-poc
Open

docs: add PoC API reference at /docs/api-reference-preview using Scalar#4845
philip wants to merge 7 commits into
mainfrom
api-doc-poc

Conversation

@philip
Copy link
Copy Markdown
Collaborator

@philip philip commented May 3, 2026

Adds a proof-of-concept API reference page at docs/api-reference-preview using Scalar as the renderer. Not linked from nav. Excluded from robots.txt. For internal review.

What's included

  • Scalar CDN bundle (@scalar/api-reference@1) mounted into the existing docs layout (Neon header, no sidebar)
  • Spec fetched server-side from neon.com/api_spec/release/v2.json, cached 5 min; info.contact stripped, stale neon.tech/docs/ links rewritten to neon.com/docs/
  • Dark and light mode, synced with neon-website's next-themes toggle
  • Neon brand theme applied via Scalar CSS custom properties
  • Sidebar offset (--scalar-custom-header-height) set to match Neon's sticky header height
  • Scalar-specific features disabled: Ask AI agent, MCP generation, toolbar, Models section, "Open API Client" button
    Not included / deferred

@vercel
Copy link
Copy Markdown

vercel Bot commented May 3, 2026

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

Project Deployment Actions Updated (UTC)
neon-next Ready Ready Preview, Comment May 7, 2026 8:15pm

Request Review

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