Reference
Reference pages answer exact lookup questions. They do not replace getting started guides, modeling explanations, or production recipes.
Verification Status
Every non-index Reference page declares one of these evidence states in machine-readable front matter:
- Verified: checked against a named command, source, generated workspace, or runtime document.
- Version-sensitive: valid only for the version stated on the page.
- Provisional: useful current evidence, but not yet a complete contract.
- Unverified: retained only as a gap; do not automate against it.
- Historical: immutable evidence from a dated campaign; not present-day release or capability status.
A short page is preferable to a comprehensive-looking page built from guessed defaults or method names.
Lookup Map
| Need | Reference |
|---|---|
| Canonical TeaQL terms for developers and AI coding agents | TeaQL Glossary |
| Java, Rust, TypeScript, Swift, Python, .NET, and Go runtime selection | Language Support Overview |
| Current generator and seven-runtime package versions | Latest Versions |
| Seven-runtime semantic, workspace, and TFP alignment | Cross-language Conformance Status |
| Cargo and Maven command entry points | Client Tools |
| Runtime configuration | Configuration Properties |
| Rust environment settings | Environment Variables |
| Evaluation and runtime failures | Reading Markdown Reports and Diagnostics Catalog |
| Symptom-oriented recovery paths | Troubleshooting Index |
| SQL evidence, audit, telemetry, and tenant-policy release gate | Debugging and Governance Checklist |
| Local/Redis cache, Local/Remote Lock, Nacos, Consul, health, metrics, and lifecycle | Runtime Infrastructure |
| Java, Rust, generator, and provider alignment | Compatibility Matrix |
| Dated stack-specific compatibility evidence | Java Compatibility Archive, Rust Compatibility Archive, and Database Provider Compatibility |
| Generated, runtime, and extension API boundaries | Java API Map and Rust API Map |
| Persistence ID range, storage, and transport rules | Portable Entity ID Range |
| Version meaning, support status, upgrade process, and breaking changes | Version Policy, Support Lifecycle, Upgrade Guide, and Migration Notes |
| Release history and publication requirements | Changelog and Release Notes |
| Documentation ownership and verification rules | Documentation Maintenance |
| Reproducible checks and dated results | Verification Evidence Archive |
| Runnable fixtures, illustrative scenarios, and historical reports | Examples and Evidence Index |
| KSML terms and validation rules | KSML Vocabulary |
| Java and Rust agent tool boundaries | Java Sandbox and Rust Sandbox |
Required Metadata
Every non-index Reference page must declare:
| Field | Meaning |
|---|---|
| Verification status | verified, version-sensitive, provisional, unverified, or historical. |
| Authority | Command, source, generated artifact, or maintained runtime page used as evidence. |
| Verified version | Version or evidence boundary most recently checked; an explicit gap is preferable to an invented value. |
| Owner | Maintainer role accountable for review. |
| Update trigger | Product change that requires the page to be reviewed. |
Pages should also explain their scope and repeatable verification method in reader-facing content when those details affect adoption.
Reference Maintenance Rule
When behavior differs from a page:
- Preserve the exact command, error, version, and generated output.
- Determine whether the installed tool or the page is stale.
- Update the page from authoritative evidence.
- Do not make generated source match the documentation by hand.