Files
logos-tutorial/docs/spec.md

23 lines
952 B
Markdown
Raw Permalink Normal View History

# Tutorial YAML Spec Format
2026-05-30 10:06:22 -04:00
The executable-tutorial format and its runner now live in the shared **doctest**
tool. See the canonical reference:
2026-05-30 10:06:22 -04:00
- **Spec format:** [`logos-doctest/docs/spec.md`](https://github.com/logos-co/logos-doctest/blob/master/docs/spec.md)
(or `repos/logos-doctest/docs/spec.md` inside the workspace)
- **Tool & CLI:** [logos-doctest](https://github.com/logos-co/logos-doctest)
2026-05-30 10:06:22 -04:00
The `*.test.yaml` specs in `tests/` use that format. Run and generate them by
invoking the `doctest` CLI directly via its flake:
2026-05-28 14:20:59 -04:00
```bash
2026-05-30 10:06:22 -04:00
# Execute a tutorial spec end-to-end
nix run github:logos-co/logos-doctest -- run tests/tutorial-wrapping-c-library.test.yaml --verbose
# Generate the .md tutorial from a spec
nix run github:logos-co/logos-doctest -- generate tests/tutorial-wrapping-c-library.test.yaml
2026-05-28 14:20:59 -04:00
```
2026-05-30 10:06:22 -04:00
To run against a local checkout, swap `github:logos-co/logos-doctest` for
`path:../logos-doctest` (or wherever your checkout lives).