gorkem-bwl
0d25973efb
## Changes - Bump @astrojs/starlight to ^0.32.0 so starlight-openapi 0.13's plugin contract (top-level setup hook) is supported - Replace the no-arg docsLoader call with Astro's glob loader pointing at ../api-content so prose stays outside the Astro project tree - Rename introduction.md → index.md and update the sidebar slug so the /docs/ root resolves instead of returning 404 - Commit package-lock.json so Vercel installs deterministically ## Verification - npm run build produces 96 pages (7 narrative + 88 OpenAPI operations + 1 releases timeline) - /docs/, /docs/releases/, /docs/api-reference/operations/authlogin/ and every other route return 200 locally - 14 release cards render with the brand-green "Latest" badge on v3.7.1
80 lines
2.4 KiB
JavaScript
80 lines
2.4 KiB
JavaScript
import { defineConfig } from "astro/config";
|
|
import starlight from "@astrojs/starlight";
|
|
import starlightOpenAPI, { openAPISidebarGroups } from "starlight-openapi";
|
|
|
|
// The OpenAPI spec lives in the server package. The Starlight integration
|
|
// reads it at build time and generates the full /api/reference/* tree.
|
|
const OPENAPI_PATH = "../../server/openapi.json";
|
|
|
|
export default defineConfig({
|
|
// Served at https://checkmate.so/docs — the leading slash is included so
|
|
// every internal link resolves correctly when fronted by a reverse proxy.
|
|
base: "/docs",
|
|
site: "https://checkmate.so",
|
|
|
|
integrations: [
|
|
starlight({
|
|
title: "Checkmate API",
|
|
description: "Use the Checkmate REST API to manage monitors, incidents, status pages, notifications, and users programmatically.",
|
|
|
|
// Prose markdown is loaded from /docs/api-content via the custom
|
|
// docsLoader in src/content.config.ts. Keeping content outside the
|
|
// Astro project tree means contributors can edit it without dealing
|
|
// with Astro / Starlight tooling.
|
|
|
|
logo: {
|
|
src: "./src/assets/logo.svg",
|
|
replacesTitle: true,
|
|
},
|
|
favicon: "/favicon.svg",
|
|
customCss: ["./src/styles/checkmate.css"],
|
|
|
|
social: {
|
|
github: "https://github.com/bluewave-labs/Checkmate",
|
|
},
|
|
|
|
// Inject a "Releases" link into the site header.
|
|
components: {
|
|
SocialIcons: "./src/components/HeaderLinks.astro",
|
|
},
|
|
|
|
sidebar: [
|
|
{
|
|
label: "Getting started",
|
|
items: [
|
|
{ label: "Introduction", slug: "" },
|
|
{ label: "Quickstart", slug: "quickstart" },
|
|
{ label: "Authentication", slug: "authentication" },
|
|
],
|
|
},
|
|
{
|
|
label: "Core concepts",
|
|
items: [
|
|
{ label: "Conventions", slug: "conventions" },
|
|
{ label: "Errors", slug: "errors" },
|
|
{ label: "Rate limiting", slug: "rate-limiting" },
|
|
],
|
|
},
|
|
{
|
|
label: "API reference",
|
|
items: [
|
|
{ label: "Overview", slug: "api-reference/overview" },
|
|
// The OpenAPI plugin appends every endpoint under this group.
|
|
...openAPISidebarGroups,
|
|
],
|
|
},
|
|
],
|
|
|
|
plugins: [
|
|
starlightOpenAPI([
|
|
{
|
|
base: "api-reference",
|
|
label: "REST API",
|
|
schema: OPENAPI_PATH,
|
|
},
|
|
]),
|
|
],
|
|
}),
|
|
],
|
|
});
|