Skip to content

Repository files navigation

Determa State documentation

The manual, beginner-friendly tutorial, and documentation website for Determa State.

The tutorials currently target synchronized Determa State 0.2.0 and the numeric format: 1 grammar. Start with Your first machine.

One source, two views

Every chapter is ordinary Markdown:

  • GitHub renders the files under docs/ directly.
  • MkDocs Material builds those same files as a searchable static site.
  • Runnable files are extracted from named Markdown code fences during validation. They are never maintained as duplicate authored copies.

This repository explains and demonstrates Determa State. The specification and conformance suite remain normative.

Independent, fully working real-world applications live in fruwehq/determa-state-examples.

Validate locally

Python 3.11 or newer, Rust 1.95.0, and Git are required.

python -m venv .venv
. .venv/bin/activate
python -m pip install --requirement requirements.txt
make sources
make check

make check verifies the pinned source versions, specification/core/profile coverage totality, YAML 1.2 parsing, JSON Schema validity, Python and Rust traces, and the strict MkDocs build.

Use make serve to preview the site locally.

Status

The released format-1 user-facing surface is taught and executed across the progressive guides. The machine-readable coverage.yaml inventories every normative section, core conformance case, and released execution-checkpoint profile case as covered or deliberately non-user-facing.

Persistence and definition migration include a durable execution-checkpoint tutorial, a lower-level SQLite transaction walkthrough, and an advanced 108-vector Python/Rust reference lab. Aggregate packages are supported as content-addressed transport; portable package imports in machine definitions remain unsupported.

See CONTRIBUTING.md before changing examples or coverage.

Licensed under the MIT License.

About

Manual, tutorials, and documentation site for Determa State

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages