Choose the right XRTM docs lane

XRTM is AI for event forecasting. The docs are organized into explicit lanes so released workflows, near-term unreleased work, package references, and governance do not blur together.

xrtm.org is the presentation layer for the ecosystem. Product behavior and released run-artifact contracts live in xrtm-org/xrtm, package APIs and source examples live in their owning repos, and schema/policy truth lives in xrtm-org/governance.

Quick chooser

If you need...	Start here	Status	Canonical owner
the shortest honest first success	Getting started	Released	xrtm repo + published xrtm==0.3.1 package
released compare/export/monitor workflows	Released user path	Released	xrtm repo
branch-only conveniences that are real but unreleased	Next release track	Explicitly unreleased	xrtm/docs/next-release-feature-track.md + governance policy
package boundaries, APIs, and source examples	Developer & package reference	Repo-map summary	owning package repo
binding schemas, feature labeling rules, or release policy	Governance & standard	Authoritative	governance repo
longer-horizon or experimental ideas	Roadmap	Future-facing	roadmap + owning repos

Released user path

Use these pages when you want the public xrtm==0.3.1 surface today:

• Getting started: provider-free first success on the released package
• Researcher / model-eval workflow: released benchmark, compare, and export loop
• Operator runbook: released monitoring, history, report, and smoke checks
• Team workflows: honest current-team usage without overselling built-in multi-user features
• Examples and proof: released proof flows plus shipped source examples

Next release lane

Use this when useful source work exists, but it is intentionally not part of the released newcomer path yet:

• Next release track: public summary of near-term unreleased features and their graduation status
• Roadmap: future, planned, or experimental work that is not on the next coordinated release train

Developer & package reference

Use this lane after the released product path is clear and you need the right package boundary:

• Developer / integrator workflow: quick chooser for product shell vs package APIs
• Packages and architecture: repo map and package ownership boundaries
• Package summaries:
  • xrtm-forecast
  • xrtm-eval
  • xrtm-data
  • xrtm-train

Governance & standard

These pages summarize the binding rules without trying to replace the owning repo:

• Why the standard exists
• Forecast Object schema
• Governance overview
• Contributing: contributor-facing repo map and doc-placement rules

Project context

• Philosophy: why XRTM cares about forecasting and zero leakage

If you are new here, start with xrtm demo --provider mock --limit 1 --runs-dir runs on the released path first.