Kern's documentation site: how to install it, run it, and build modules for it.
The site people read is built from the Markdown in this repository. If something about Kern was hard to work out, it belongs here.
Goal: see your change in the documentation site on your own machine.
You need:
- Node 24 and pnpm 10.
pnpm install
pnpm devExpected result: the site is at http://localhost:4400 and reloads as you type.
- Add a Markdown file under
src/content/docs/. - Add it to the sidebar in
astro.config.mjs.
Expected result: your page appears in the sidebar and opens.
pnpm buildExpected result: a static site in dist/, with no broken links reported.
The site's address is docs.kernaio.com. It is not live yet: the DNS record and GitHub Pages both still have to be switched on. Until then, build it locally.
| Where | How |
|---|---|
| GitHub Pages | .github/workflows/pages.yml, started by hand from the Actions tab |
| Docker | docker build -t kern-docs . serves the built site on port 80 |
To publish it the first time:
- Point a
CNAMErecord fordocs.kernaio.comatkernaio.github.io. - In Settings → Pages, set the source to GitHub Actions and the custom domain to
docs.kernaio.com. - Run the GitHub Pages workflow from the Actions tab.
Expected result: https://docs.kernaio.com serves this site. public/CNAME keeps the custom
domain across later deploys, and the site is built at the root — there is no /docs path prefix.
Documentation follows the house style in CLAUDE.md. Say the goal first. Put one action in each step. Keep sentences short. Put the condition before the command. After every important action, say what the reader should see.
Read CONTRIBUTING.md.
AGPL-3.0-only. This repository is part of the Kern product. The Kern framework you build modules against is Apache-2.0 — see LICENSING.md.
Kern — one place for your team's work: issues, conversations, documents and people. Open source, self-hosted. kernaio.com · github.com/KernAIO