kindlings-doc-maintenance

What problem does it solve?

Writing and testing executable code snippets in the Kindlings user guide to keep documentation accurate and verifiable.

Core Features & Use Cases

• Snippet testing with scala-cli-md-spec: CI validates docs/user-guide/**/*.md and runs the snippet tests defined in scripts/test-snippets.scala.
• Output verification and template variables: deterministic outputs are checked with // expected output annotations, ensuring reliable documentation previews.
• Local and CI workflow integration: provides guidance to run all snippet tests locally or as part of a CI pipeline.

Quick Start

Run the documentation snippet tests in docs/user-guide to verify deterministic outputs.