Keel is a Go framework for building REST APIs with modular architecture, automatic OpenAPI, and built-in validation.
Live site: docs.keel-go.dev
Framework repo: slice-soft/ss-keel-core
Tracks: ss-keel-core v0.11.0 plus split documentation for live addons
src/content/docs/
├── guides/ # Step-by-step guides (getting started, controllers, modules…)
├── cli/ # CLI reference
├── addons/ # Addon hub pages plus split sections (overview, installation…)
└── reference/ # API reference (App, Route, Ctx, errors…)
All pages are .md or .mdx files. Each file maps directly to a URL route.
npm install
npm run dev # http://localhost:4321npm run build # Production build → ./dist/
npm run preview # Preview the built site locallyContent lives in src/content/docs/ — addon home pages live at addons/ss-keel-*.md, and deeper addon guides live in sibling folders such as addons/ss-keel-jwt/overview.md. Update astro.config.mjs whenever you add or move navigable pages.
The base workflow, commit conventions, and community standards live in ss-community. For changes to the framework itself, open a PR in the core repo.
| Document | |
|---|---|
| CONTRIBUTING.md | Workflow, commit conventions, and PR guidelines |
| GOVERNANCE.md | Decision-making, roles, and release process |
| CODE_OF_CONDUCT.md | Community standards |
| VERSIONING.md | SemVer policy and breaking changes |
| SECURITY.md | How to report vulnerabilities |
| MAINTAINERS.md | Active maintainers |