Skip to content

kave-io/docs

Repository files navigation

Kave Docs

This is the documentation site for Kave, built with Astro and Starlight.

Run locally

bun install && bun run dev

Content layout

All authored docs live under src/content/docs/.

The generated reference trees are populated in CI from the main Kave monorepo:

  • src/content/docs/cli/reference/ from the Go CLI
  • src/content/docs/config/reference/ from the YAML/config schema
  • src/content/docs/api/grpc/ from .proto files
  • src/content/docs/api/json-schemas/ from CLI JSON output schemas

Writing model

The site follows Diátaxis:

  • concepts/ for explanation pages
  • get-started/ for tutorials
  • guides/ for how-to guides
  • cli/, config/, and api/ for reference

Adding a page

Use numbered filenames for ordered sections, add frontmatter with title, description, sidebar.label, diataxis, and status, and update the sidebar manually if the page is not in an autogenerated group.

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors