Help

Help

Purpose

This page explains how to place and maintain content in the wiki.

The structure follows reader intent: how the system is built, what it does, how to work with it, which rules are mandatory, and which material is only background reference.

Where to put pages

• Designs - architecture, boundaries, event flow, aggregate design, projection design, and durable decisions.
• Features - product behavior, business capabilities, and feature-specific command/event flows.
• Releases - release-window notes, deployment coordination, rollout risks, and release-specific troubleshooting.
• Guides - local development, migration, replay, operations, support, and troubleshooting steps.
• Tools - repository-specific scripts, console commands, and administrative utilities when they need dedicated reference pages.
• Standards - mandatory rules and checklists.
• References - external links, source maps, and background material that should not be read as current implementation documentation.

Maintenance rules

• Update Home and _Sidebar when adding, renaming, or removing important pages.
• Prefer focused pages over large catch-all pages.
• Link related pages so readers can move from overview to implementation detail.
• Include source references with repository-relative paths where practical.
• Keep current behavior grounded in source code, tests, and configuration.
• Record uncertainty in an Open questions section instead of presenting guesses as facts.
• Do not include secrets, tokens, private credentials, or production-only sensitive values.