Skip to content

Contributing

How to migrate, verify, review, and maintain Atoll documentation.

Updated View as Markdown

Treat docs/ as an archive of evidence, not a directory to copy wholesale. A migrated chapter should reconcile prose with the current compiler and say which implementation sources were checked.

Evidence order

Use the strongest source appropriate to the claim:

  1. public ABI/schema contracts and explicit invariants;
  2. current implementation data types and algorithms;
  3. focused executable tests and accepted source fixtures;
  4. current design documents;
  5. older overview and planning documents.

Tests prove covered behavior, not completeness. Design documents explain intent, but may lead or lag the implementation.

Page states

  • verified: checked against implementation and focused tests;
  • provisional: coherent and useful, with remaining verification work;
  • planned: a stable content scope, not yet a specification.

Use sourceDocs for migrated prose and verifiedAgainst for code, schemas, or tests used to validate claims.

Naming and examples

Follow the current naming conventions. Do not mechanically preserve Int, Boolean, camelCase methods, let, or other spellings from an older document. Examples should be parser-tested and, where semantics matter, compiler-tested.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close