Skip to main content

Crate expectation_docs

Crate expectation_docs 

Source
Expand description

Documentation from a suite, written as a manual: stories become step-by-step tutorials, features become topic pages, and sections say what to do before you begin. The test output (each test’s steps, checks and verdicts, and the map of the expectation DAG) goes into collapsed “How this is tested” blocks and a separate test report. Two outputs from the same facts:

README.md, tutorials/, features/,      Markdown that GitHub renders
  glossary.md, tests.md, tests/
site/                                   the same as an HTML site with nested navigation
screenshots/…                           written by the harness while the tests run

The wording comes from the specs: Say: on an event or phrase tells the reader what to do (“press Space”), Set: on a state tells them how to change it, and a story’s text under its narrative is the tutorial’s introduction. voice turns steps into instructions with them. A step without a screenshot (its test isn’t supported yet, didn’t run, or failed before it got there) shows a placeholder instead.

Modules§

outline
The manual’s outline: the order the reader meets the chapters in, grouped into parts, with hand-written pages (install, controls, reference, troubleshooting) among the generated ones. The sections stay as the specs have them, because their setups inherit from their parents; the outline only says where each top-level chapter goes.

Structs§

Docs
Page
Sibling
The pages of the same manual for another platform.

Constants§

NOT_SUPPORTED
Where the placeholders live, relative to the docs directory.
NO_SCREENSHOT