Contributing content

Page schema for adding docs to this site.

This site is generated by rsites. Read AGENTS.md at the site root.

The user guide (content/docs/*.md with extra.generated = true, plus content/docs/_index.md) comes from scripts/generate-docs.py and the doc/ tree in the rabun-git checkout. Edit that guide in rabun-git, then regenerate. Marketing pages (content/_index.md, content/install/, content/web/) stay in this repo.

Frontmatter

Pages use TOML fences (+++), not YAML (---).

A documentation article:

+++
title = "Short title"
description = "One sentence."
weight = 10
+++

Write the body in Markdown.

A documentation section (_index.md under content/docs/):

+++
title = "Guides"
description = "How to use the project."
sort_by = "weight"
template = "docs.html"
page_template = "doc-page.html"
+++

Paths

  • Home is content/_index.md.
  • Docs live under content/docs/.
  • Do not edit themes/ or public/.

After you add or change a page, run rsites check. Preview with rsites serve.

If you add a top-level section besides Docs, add a matching link in [extra.devlab.navigation] in zola.toml.

Tera in Markdown

Zola runs Tera on Markdown bodies. Wrap literal template tags in a Tera raw block so they are not executed.