API Documentation Polish & Static Content Pipeline
Sidebar Chevron Indicators
- SVG replaces Unicode character — the sidebar disclosure indicator now uses an inline SVG chevron instead of the Unicode
▸glyph. The previous character rendered as an ambiguous dot on iOS Safari and varied across platforms. The SVG renders pixel-perfect on every browser and device, with hardware-accelerated rotation animation between collapsed and expanded states.
Mobile Scroll Stability
Sidebar scroll position preserved across page navigation — clicking a link in the sidebar no longer resets the scroll position to the top. Position is saved before navigation begins and restored seamlessly using a visibility-based anti-flicker pattern.
Light theme flash eliminated — a brief flash of unstyled content on the light theme during scroll restoration has been resolved. The sidebar is now hidden with
visibility: hiddenduring the restore window, preventing any bleed-through.iOS Safari URL bar jitter resolved — on iOS Safari, scrolling triggers the URL bar to collapse, which fires a resize event and recalculates the viewport height mid-scroll. The resize handler now only recalculates when the viewport width changes (device rotation), ignoring vertical-only resize events caused by the URL bar animation.
API Reference Documentation
Five new reference pages in the API Reference section, all with scroll-synced code panel examples:
Authentication — covers API key authentication via
X-API-Keyheader, JWT bearer token login flow, two-factor authentication (TOTP) with the full temporary token handshake, token refresh, scoped permissions table, account lockout behaviour, and security recommendations.Errors — documents the error response envelope, all HTTP status codes and error codes, idempotency error behaviour, and a five-point integration guide for handling errors programmatically.
Pagination — covers request parameters, response metadata, a JavaScript iteration example, sorting and filtering patterns, empty result handling, and rate limiting considerations.
Conventions — describes the response envelope, prefixed ID system, monetary values in minor units, ISO 8601 date formats, custom metadata with merge semantics, idempotency keys, content type requirements, and the versioning policy.
Rate Limiting — documents the default 100 requests per minute limit, per-endpoint auth rate limits (login, TOTP, refresh, registration, password reset, email verification), response headers, and an exponential backoff example.
Static Content Pipeline
API Reference pages migrated to static Markdown — all API Reference preamble pages now use the same static page pipeline as Getting Started, Concepts, and Guides. Content lives in
api-reference/*.mdfiles with full frontmatter support for code blocks and scroll sync points. New pages can be added by dropping a Markdown file into the directory.Sidebar now merges static and preamble sources — the API Reference sidebar section pulls pages from both the static Markdown pipeline and the OpenAPI snapshot, with automatic deduplication. Static pages are sorted by
sidebar_positionfrontmatter.Getting Started authentication route fix — renamed the Getting Started authentication tutorial to avoid a route collision with the new API Reference authentication page.