docs

package
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 26, 2026 License: MIT Imports: 0 Imported by: 0

Documentation

Overview

Package docs holds the documentation verification harness.

It treats the project's documentation as tested fixtures (Constitution Principle VI): every example Runefile statically validates, fenced rune code blocks on self-contained pages validate, example directories satisfy the example contract, internal links resolve, and no secret literals leak. The harness builds the rune binary once (see TestMain) and runs it, mirroring test/integration. Tests run inside Docker per project policy (CONTRIBUTING.md).

There is no built-in `rune check` subcommand; static validation uses `rune --file <path> --list`, which forces parse+analyze and runs nothing.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL