Add machine authoring API guide

[SandroMaglione]

Summary

• Generate a standalone machine authoring guide from TypeDoc reflections, including nested configuration, transition, handler-context, and invocation APIs.
• Keep module reference pages focused on public exports while giving the guide a complete, flattened page outline and readable parameter blocks with attached source links.
• Add missing JSDoc descriptions and focused examples for the reflected APIs, plus generator and site coverage for the new model.

Changeset

• Added or updated for a library or package-metadata change
• Not required because this PR does not change src/ or package.json

Validation

• pnpm check
• Relevant example checks, when examples changed (not required; no example package changed)
• Automated type-performance measurement passed or was not required
• Automated runtime- and memory-performance measurement passed or was not required

Local pnpm perf:types and pnpm perf:runtime smoke checks also completed successfully. The CI base-versus-PR reports remain authoritative.

[github-actions]

Type performance

Measured with TypeScript 6.0.3 and skipLibCheck=true.

Scenario	Base	PR	Difference
Effect only	55	55	0 (0.0%)
Import effect-machine	55	55	0 (0.0%)
Machine.states (3 states)	3,039	3,039	0 (0.0%)
Machine.make (3 states, 2 events)	10,759	10,759	0 (0.0%)
machine.handle (3 states, 2 transitions)	28,192	28,192	0 (0.0%)
fluent transition (10 named branches)	106,006	106,006	0 (0.0%)
fluent invocation (state-dependent Effect)	92,756	92,756	0 (0.0%)
machine.handle (depth 24)	192,588	192,588	0 (0.0%)
machine.handle (wide depth 16)	220,950	220,950	0 (0.0%)
machine.handle (parallel/history/choice)	128,389	128,393	+4 (+0.0%)
machine definition (3 independent implementations)	127,342	127,346	+4 (+0.0%)
machine exact input/output/error/services	113,924	113,924	0 (0.0%)
execution adapter readiness	120,582	120,586	+4 (+0.0%)

Marginal instantiations are measured against the matching setup without that API call:

Scenario	Base	PR	Difference
Import effect-machine	0	0	0
Machine.states (3 states)	2,984	2,984	0 (0.0%)
Machine.make (3 states, 2 events)	7,712	7,712	0 (0.0%)
machine.handle (3 states, 2 transitions)	17,433	17,433	0 (0.0%)
fluent transition (10 named branches)	95,757	95,757	0 (0.0%)
fluent invocation (state-dependent Effect)	83,491	83,491	0 (0.0%)
machine.handle (depth 24)	171,892	171,892	0 (0.0%)
machine.handle (wide depth 16)	201,461	201,461	0 (0.0%)
machine.handle (parallel/history/choice)	108,126	108,130	+4 (+0.0%)
machine definition (3 independent implementations)	111,373	111,377	+4 (+0.0%)
machine exact input/output/error/services	99,413	99,413	0 (0.0%)
execution adapter readiness	90,770	90,770	0 (0.0%)

Check times (informational)

Scenario	Base	PR
Effect only	0.03s	0.03s
Import effect-machine	0.03s	0.03s
Machine.states (3 states)	0.11s	0.10s
Machine.make (3 states, 2 events)	0.20s	0.18s
machine.handle (3 states, 2 transitions)	0.27s	0.27s
fluent transition (10 named branches)	0.52s	0.53s
fluent invocation (state-dependent Effect)	0.52s	0.50s
machine.handle (depth 24)	0.84s	0.82s
machine.handle (wide depth 16)	0.86s	0.85s
machine.handle (parallel/history/choice)	0.66s	0.66s
machine definition (3 independent implementations)	0.67s	0.66s
machine exact input/output/error/services	0.61s	0.59s
execution adapter readiness	0.61s	0.62s

Type instantiations are the comparison metric. Check time varies with runner load and is informational only.

[github-actions]

Runtime performance

Median of 5 independent benchmark processes on AMD EPYC 7763 64-Core Processor with Node v24.19.0.

Pull request baseline

Scenario	Effect Machine
Plan counter transitions	117,233 transitions/s
Drain burst with terminal fence	351,540 increments/s
Drain burst with a change observer	330,499 increments/s
Lookup and send to one child	293,370 increments/s
Start and stop a machine	139,997 machines/s
Start and stop a parent with one child	27,278 families/s
Plan transitions through a compound state	100,359 transitions/s
Plan transitions through parallel regions	82,121 transitions/s
Drain burst through a compound state	300,093 events/s
Drain burst through two parallel regions	304,209 events/s
Drain a compound-state burst with a change observer	283,470 events/s

Process runtime reference points

Scenario	Effect Machine
Start and stop a raw generic process	15,523 processes/s
Start and stop a raw compiled process	62,108 processes/s

Memory profile	Effect Machine
Idle machine	1.8 KiB
Raw generic managed process	13.9 KiB
Raw compiled process	3.1 KiB
Two independent idle machines	3.4 KiB
Idle parent with one child	5.8 KiB
Parent with observed child registry	10.0 KiB
Parent with observed invoked child snapshots	6.3 KiB

Effect Machine change from base

Metric	Base	Base variability	PR	PR variability	Difference
Plan counter transitions	117,345 transitions/s	1.5% MAD	117,233 transitions/s	0.4% MAD	-0.1%
Drain burst with terminal fence	351,693 increments/s	0.6% MAD	351,540 increments/s	1.5% MAD	-0.0%
Drain burst with a change observer	331,346 increments/s	0.4% MAD	330,499 increments/s	1.0% MAD	-0.3%
Lookup and send to one child	293,836 increments/s	0.7% MAD	293,370 increments/s	0.5% MAD	-0.2%
Start and stop a machine	142,592 machines/s	1.0% MAD	139,997 machines/s	1.2% MAD	-1.8%
Start and stop a parent with one child	28,188 families/s	1.6% MAD	27,278 families/s	1.0% MAD	-3.2%
Plan transitions through a compound state	100,336 transitions/s	0.4% MAD	100,359 transitions/s	1.1% MAD	+0.0%
Plan transitions through parallel regions	82,337 transitions/s	0.3% MAD	82,121 transitions/s	0.2% MAD	-0.3%
Drain burst through a compound state	304,187 events/s	0.9% MAD	300,093 events/s	1.9% MAD	-1.3%
Drain burst through two parallel regions	306,695 events/s	0.8% MAD	304,209 events/s	0.9% MAD	-0.8%
Drain a compound-state burst with a change observer	286,906 events/s	0.5% MAD	283,470 events/s	2.0% MAD	-1.2%
Idle machine heap per unit	1.8 KiB	0.0% MAD	1.8 KiB	0.0% MAD	0.0%
Raw generic managed process heap per unit	13.9 KiB	0.0% MAD	13.9 KiB	0.0% MAD	+0.0%
Raw compiled process heap per unit	3.2 KiB	0.4% MAD	3.1 KiB	0.4% MAD	-0.4%
Two independent idle machines heap per unit	3.4 KiB	0.0% MAD	3.4 KiB	0.1% MAD	+0.0%
Idle parent with one child heap per unit	5.8 KiB	0.0% MAD	5.8 KiB	0.0% MAD	-0.0%
Parent with observed child registry heap per unit	10.0 KiB	0.0% MAD	10.0 KiB	0.0% MAD	-0.0%
Parent with observed invoked child snapshots heap per unit	6.3 KiB	0.0% MAD	6.3 KiB	0.0% MAD	-0.0%

Process runtime reference change from base

Metric	Base	Base variability	PR	PR variability	Difference
Start and stop a raw generic process	15,763 processes/s	2.2% MAD	15,523 processes/s	3.1% MAD	-1.5%
Start and stop a raw compiled process	62,305 processes/s	2.4% MAD	62,108 processes/s	0.7% MAD	-0.3%

Regression guard

No large, noise-adjusted throughput or heap regressions detected.

Versions and interpretation

• Effect Machine: 0.18.0

Higher throughput is better; lower heap is better. Variability is the median absolute deviation across independent processes, relative to their median. Small differences on shared GitHub-hosted hardware remain informational; the required guard rejects only large changes beyond the measured noise allowance.