jzombie / rust-oxdock / 37833624352

85%

Build Type

push

github

Committed by web-flow

Commit Message

feat(docs): Linkable evaluation contexts (#194)

### Added

- Linkable evaluation contexts (#184): function reference `**Contexts:**` lines now link to a generated `## Contexts` section (`#context-ast`, `#context-rpn`), rendered once per document from function metadata, so every builtin and plugin function documents where it runs.
- New `Machine model` docs section covering words, the two evaluators, and the stack program, with live lowering demos: `OXDOCK::LOWER_MATH($src)` lowers an expression through the real parser at docs render time and bakes the true op program into the page, so the shown bytecode cannot drift from the implementation. The op renderer matches exhaustively over `MathOp` and exact-output unit tests pin the shown bytes.
- `oxdock_parser::parse_expression_str`: parse one expression from source text with an empty module scope, for tooling that shows lowering without running.
- CI `docs-fresh` job regenerates docs with `cargo run -p docs-gen` and fails on any diff, so stale generated docs break the build.

### Fixed

- `CITATION.cff` was three releases stale (`0.20.0-alpha` while the workspace moved on); it is now rendered by `docs-gen` from the workspace manifest like every other generated artifact, so its version tracks releases automatically.

Coverage Stats

217 of 233 new or added lines in 5 files covered. (93.13%)

4 existing lines in 1 file now uncovered.

34199 of 40706 relevant lines covered (84.01%)

1545.37 hits per line