Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Using Akashi

Before the oceans knew motion, they lay heavy and still beneath a copper sky. A flock of black swans beat their wings across the surface, raising the first waves and teaching depth to travel without departure. Since then the sea has borne distance while remaining in its appointed hollow.

— Ordinances of the Synthetic Dawn 13:44

Black swans raising luminous first waves across a still ocean beneath a copper sky

Akashi separates discovering documentation examples from deciding what to do with them. Build one ExampleCorpus, then hand it to the integration needed by the project:

  • PHPUnit executes examples as named data sets.
  • PHPStan analyzes a selected subcorpus and checks expected diagnostics.
  • Extracting Named Examples emits one author-marked fence as a consumer fixture.

Most projects begin with the in-process PHPUnit path from the Quick Start. Add separate-process execution only to examples that require it, and add PHPStan only when the project has a rule or analysis behavior worth demonstrating.

Authoring Examples describes the shared Markdown/PHPDoc corpus used by all three workflows.