About these docs

How it is built

• Framework: Starlight 0.42 (Astro 7), static output; search by Pagefind (CJK-aware).
• Languages: Chinese first (the root), English at /en/, switched by “中/EN” at the top.
• Theme: dark by default with a light toggle, in the brand colors of the entelechy.run site.
• Code: Expressive Code with TextMate grammars written for .ent/.esn and .replay; every block has a copy button.
• Version: these docs describe 0.0.2-rc.3 (main at generation time). The version selector is a placeholder for now.

Where content comes from

Part	Source	How
About, Getting started, Manual	README.md, HANDOFF.md, docs/*.md, examples/, bridges/	hand-written; each page’s footer lists its source files
Command output in tutorials	entelechy 0.0.2-rc.3 actually run on Linux x86_64	pasted as is (... where long lines were cut)
Reference · types/builtins/capabilities/language/protocol/commands	entelechy help --json, entelechy’s usage text, protocol/src/wire.rs	generated by scripts/gen_reference.py
Reference · packages	entelechy serve on each package with kernels/kernel, sources parsed	scripts/extract_packages.py
Reference · crates	cargo rustdoc --output-format json (nightly)	scripts/extract_rustdoc.py
Example gallery	examples/* and the repository’s docs/media	scripts/gen_examples.py

Verified and not

Run here: cargo build --release -p entelechy, new, check, run (with --watch, --profile), replay, graph, trace, serve (stdin), version, help, the C ABI example bridges/c/hello.c, and every .ent/.esn/.replay in the tutorials.

Not verified here (described from the repository’s docs):

• --backend gpu and best: no GPU on this machine (gpu unavailable).
• The entelechy-player window, sound and pads: they need display and audio system libraries and were not run; the Player crate has no rustdoc either (its build needs libudev).
• The WebAssembly (WASI and browser) builds; the external host, DCC-tool and web bridges.
• Behavior on Windows and macOS (HANDOFF.md verifies macOS, Apple M4, every round).

Known gaps

• Generated reference pages keep the source’s English descriptions; the Chinese side adds a one-line brief.
• xtask and entelechy-player have no crate API pages.
• Source links point into the private repository Fynn-3D/entelechy and open only with access.
• The version selector is a placeholder; there is one version.
• The architecture “bibles” (ARCHITECTURE-PLAN.md, CORE-ARCHITECTURE.md) are not transcribed, only summarized in Architecture.

Regenerating

cd /workspace/entelechy-docs
python3 scripts/extract_packages.py      # needs a built entelechy
python3 scripts/extract_rustdoc.py       # needs nightly rustdoc JSON
python3 scripts/gen_reference.py
python3 scripts/gen_examples.py
npm run build                            # writes dist/