Development

This section is for contributors and maintainers. User documentation (getting started, tutorials, how-to, concepts, reference) lives in the other sections; here you find how the code is structured, how it is tested and validated, and how to contribute.

• Documentation style guide
• Testing
• Numerical validation
• Version control and branch management

Canonical design guides

The design documents are the contributor reference and stay at the repository root:

• ARCHITECTURE: the five layers, the modules, the dispatch seam, the AMR engine.

• ALGORITHMS: the numerical methods, fluxes, reconstruction, elliptic solvers, time integration.

• CHOICES: the deliberate design trade-offs.

• BACKEND_COVERAGE: the backend and test matrix.

Decision records

Architecture Decision Records capture a deliberate cross-cutting choice and its alternatives. They stay at the repository root next to the design guides:

• ADR-0001 Genericity contracts: 2D core invariant, explicit model spec, named aux, roles, and configurable AMR regrid (ADC-294 / ADC-290 / ADC-291 / ADC-292 / ADC-296).

Process

• CONTRIBUTING: the build, test and pull-request workflow.

• SECURITY: how to report a vulnerability.

• VERSIONING: the public API under SemVer and the release steps.