Skip to content

Improve API documentation - #869

Open
litury wants to merge 7 commits into
developfrom
fix/api-docs-layout
Open

litury wants to merge 7 commits into
developfrom
fix/api-docs-layout

Conversation

@litury

@litury litury commented Sep 27, 2026 •

Copy link
Copy Markdown
Collaborator

Issue

The API reference had overflowing examples and dense descriptions that were difficult to scan. Endpoint navigation, request examples, and response details also lacked consistent presentation.

Things done

  • Align the reference with the existing design and keep examples inside their cards

  • Add searchable endpoint navigation with scroll tracking and collapsible sections

  • Separate requests from responses, with HTTP/cURL controls and JSON highlighting

  • Clarify parameters, response notes, and status codes across 75 endpoints

  • Copy endpoint documentation and export Markdown from the same source

  • Pin the existing transitive Yarn core dependency to 4.9.1 so npm can install the workspace (same fix as Fix homepage data refresh #868)

Checks

Frontend build, TypeScript, and Biome pass. Checked keyboard navigation, search, copying, direct links, and layouts from 320 to 1440 px with Playwright.

@vercel

vercel Bot commented Sep 27, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Deployment Actions Updated
platform-explorer Ready Ready Preview Oct 5, 2026 9:31am UTC

Request Review

@litury litury self-assigned this Sep 27, 2026
@litury litury added the frontend Related to fronted (UI) label Sep 27, 2026

This branch was successfully deployed

1 active deployment
Preview — 6e212a6a Deployed Oct 5, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

frontend Related to fronted (UI)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant