Skip to content

HiveCast and MatrixDocumentation Portal

Source-grounded reference for the entire system. 17 packages, 670+ pages, every claim tied back to code.

About these docs

The HiveCast and Matrix documentation portal is organized by product. Each product/domain has its own independent docs package — @open-matrix/docs-<product> — that builds, deploys, and versions on its own. The portal you are reading right now is the cross-package landing page.

Source-grounded, target-state-marked, no fantasy

Every page in this portal follows three rules:

  1. Present state from code. If a page describes how something works, that description is grounded in actual source files. Most pages list the exact <file>:<line> references in frontmatter under sourceCode.
  2. Target state explicitly marked. When a page describes planned behavior that is not yet implemented, the page says so — with a > **Status: target state, not yet implemented.** callout and a pointer to the workstream that owns delivering it.
  3. Never fantasy. If neither code nor an explicit roadmap supports a claim, it does not appear.

When a documentation page diverges from code, the page is wrong, not the code. Cross-references back to source make that easy to verify.

Source-portability contract

Every page is pure CommonMark + GFM — no :::tip admonitions, no MDX components, no Vue or React inline components, no framework-specific markdown extensions. Source markdown imports cleanly into VitePress, Astro Starlight, Docusaurus, or any other CommonMark-aware static site generator.

Full rules at WORKSTREAMS/product-consolidation-and-documentation/PORTABILITY-RULES.md.

Known gaps, quirks, and design decisions

While authoring this portal, sub-agents read the actual source for each package and surfaced a register of real gaps (missing implementation), intentional designs that are easy to misread, and doc/spec hygiene drift. Read Known gaps and quirks before assuming any framework behavior — it covers things like the silent $prompt seal, missing system-factotum source, the Caddy /nats-ws bypass, and a dozen others.

Legacy docs

The original VitePress docs at /apps/docs/ (architecture, operations, security, workstreams) are still served while content migration into the new domain-organized portal is in progress.