Skip to content

Documentation

Welcome! This site is organized by audience.

  • Users
  • Guides: practical how-tos and best practices
  • Reference: stable APIs and event schemas
  • Migration: user-facing migrations (empty for now)
  • Contributors
  • Technical Design: active proposals and archived designs
  • Notes: plans, findings, and historical context
  • Changelog: notable changes by release

Quickstart (Users)

  • Observability: users/guides/observability-guide.md
  • Type hints provider: users/guides/type-hints-provider-guide.md
  • Event names reference: users/reference/metrics-event-reference.md

Users

  • Guides: users/guides/
  • Reference: users/reference/
  • Migration: users/migration/

Contributors

  • Technical Design (Active): contributors/technical-design/active/
  • Technical Design (Archive): contributors/technical-design/archive/
  • Notes: notes/
  • Changelog: changelog/CHANGELOG.md

Deprecated / Historical

  • M5 milestone docs and migration notes: notes/deprecated/