Voktty documentation site

This directory is the source for the public Voktty documentation site. It is a standalone MkDocs project so documentation can be previewed without starting the Tauri application.

Requirements

  • Python with MkDocs 1.6 or newer
  • The mkdocs command available on PATH

The current site uses the built-in MkDocs theme and a local stylesheet. It does not require mkdocs-material or a Node dependency.

Local commands

Run these commands from docs:

mkdocs serve
mkdocs build --strict

The development server is available at http://127.0.0.1:8000/. The production site is written to docs/site/, which is ignored by Git.

From the repository root, use the equivalent explicit config path:

mkdocs serve -f docs/mkdocs.yml
mkdocs build --strict -f docs/mkdocs.yml

Content rules

  • Keep VOKTTY.md as the source of truth for architecture and invariants.
  • Document user-visible behavior in user-guide/ and stable contracts in reference/.
  • Mark work in progress and platform limits explicitly.
  • Use fenced examples that can be copied as-is.
  • Do not put secrets, local paths, generated site files or session notes here.
  • Keep the canonical docs in English. Translations can be added as a separate navigation branch when they have an owner.