Keel

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

Content structure

src/content/docs/
├── guides/          # Step-by-step guides (getting started, controllers, modules…)
├── cli/             # CLI reference
├── addons/          # Official addon documentation (ss-keel-gorm, ss-keel-jwt…)
└── reference/       # API reference (App, Route, Ctx, errors…)

All pages are .md or .mdx files. Each file maps directly to a URL route.

Local development

npm install
npm run dev       # http://localhost:4321

npm run build     # Production build → ./dist/
npm run preview   # Preview the built site locally

Contributing

Content lives in src/content/docs/ — find the relevant .md file and edit it directly. New pages are picked up automatically by filename; update the sidebar in astro.config.mjs if you add a new section.

The base workflow, commit conventions, and community standards live in ss-keel-community. For changes to the framework itself, open a PR in the core repo.

Community

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