gorkem-bwl
9aa2594df7
## 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
Checkmate Documentation
Welcome to the Checkmate documentation. This directory contains guides and references for various aspects of Checkmate deployment and configuration.
Available Documentation
Deployment & Configuration
- Custom CA Trust Guide - Configure Checkmate to trust custom Certificate Authorities
- Custom CA Quick Reference - Quick setup guide for custom CA trust
Docker Configuration
Custom CA Trust
If you need to monitor internal HTTPS endpoints with certificates from private Certificate Authorities (like Smallstep), see our custom CA trust documentation:
- Full Guide: Custom CA Trust Guide
- Quick Reference: Custom CA Quick Reference
Example Configurations
The docker/dev/ directory contains example configurations:
docker-compose.custom-ca-example.yaml- Example Docker Compose with custom CAserver-custom-ca.Dockerfile- Example Dockerfile for OS-level CA trustexport-smallstep-ca.sh- Helper script for Smallstep CA export
Contributing to Documentation
If you find issues or want to improve the documentation:
- Check existing issues and discussions
- Submit a pull request with your changes
- Follow the same markdown formatting style
- Include practical examples and code snippets