Reference Style

Reference entries follow a consistent shape so they are easy to scan and automate against.

Definition block template

verb: route
intent: describe metal and via steps for a stack
inputs:
  - stack: layer[]
  - constraints: drc_profile
outputs:
  - map: wafer_map
notes:
  - profiles: fab, packaging
  - stability: stable (L2)
  - examples: /examples/route-basic, /examples/route-high-density

Conventions

• Every verb states stability and the language level that introduced it.
• Inputs and outputs are typed; optional fields are called out explicitly.
• Cross-link recipes and longer walkthroughs back to the verb that powers them.
• Keep changelog snippets near the entry so upgrades are obvious.

Indexing and IDs

• Assign a stable slug per symbol (e.g., verb.route, type.layer) so generated references can cross-link reliably.
• Emit a machine-readable index (JSON) from the compiler to keep SUMMARY.md and link targets in sync.
• Favor relative links; mdBook is served at /alembic, so assets resolve without additional configuration.