## Changes - Add narrative API documentation in docs/api-content/ (introduction, quickstart, authentication, conventions, errors, rate limiting) - Scaffold Astro Starlight site at docs/api/ that consumes prose from the sibling api-content folder and auto-generates the endpoint reference from server/openapi.json via starlight-openapi - Wire Checkmate brand color (#13715B) into Starlight via custom CSS - Add vercel.json so the docs site deploys cleanly as an Astro project with root directory docs/api/ ## Benefits - Public API docs ready to publish at checkmate.so/docs - Endpoint reference stays in sync with the OpenAPI spec automatically - Zero third-party SaaS dependency: site is fully self-hosted on Vercel - Contributors edit plain markdown; no Astro knowledge needed for prose
21 lines
479 B
JSON
21 lines
479 B
JSON
{
|
|
"name": "checkmate-docs-api",
|
|
"type": "module",
|
|
"version": "0.1.0",
|
|
"private": true,
|
|
"description": "Public API documentation for Checkmate. Built with Astro Starlight.",
|
|
"scripts": {
|
|
"dev": "astro dev",
|
|
"start": "astro dev",
|
|
"build": "astro build",
|
|
"preview": "astro preview",
|
|
"astro": "astro"
|
|
},
|
|
"dependencies": {
|
|
"@astrojs/starlight": "^0.30.0",
|
|
"astro": "^5.0.0",
|
|
"sharp": "^0.33.5",
|
|
"starlight-openapi": "^0.13.0"
|
|
}
|
|
}
|