Skip to content

Chronicle, MongoDB, SQL and reference guides - #39

Merged
woksin merged 7 commits into
mainfrom
docs/batch-c
Sep 25, 2026
Merged

woksin merged 7 commits into
mainfrom
docs/batch-c

Conversation

@woksin

@woksin woksin commented Sep 25, 2026

Copy link
Copy Markdown
Contributor

Changed

  • The Chronicle documentation follows Arc's C# Chronicle guides: reactors and reactor-driven commands, event metadata and subjects, read models injected into commands and read-model failures, defining and injecting aggregate roots, compliance, and how each Chronicle code-analysis rule applies in TypeScript.
  • MongoDB guides cover the Cratis:MongoDB configuration binding, naming policies, serializers, and observing collections including errors, recovery, deleted documents and paging.
  • The SQL guides are consolidated into getting started, paging, tenancy and column types, with complete code.
  • New reference pages: a glossary, a diagnostics reference and "Why Arc for TypeScript". The capability reference now holds the evidence for each integration.

Fixed

  • Documentation no longer describes @cratis/cratis as private or states that reactor-driven commands are unavailable.

- Resolve the contradiction about returned reactor commands and move
  reactors into chronicle/reactors with an overview and a page on
  returning commands
- Add pages for event metadata, subject, compliance, read models in
  commands, read-model resolution failures, and the ARCCHR mapping
- Split aggregates into defining and injecting pages with complete code
- Expand causation, concurrency, and transactional commands from source
- Correct the claim that @cratis/cratis is private
- Document the Cratis:MongoDB configuration binding and complete the
  getting-started code
- Cover pluralization, custom policies, stored names in filters, and
  silent naming mismatches
- List read rules and mapping errors, and correct the TimeOnly format
- Cover deleted documents, paging observed queries, and stream failure
  and recovery
Fold read-only access, migrations, and observation limits into the
overview and getting-started pages, and add complete code for setup,
writes, paging, column codecs, and per-tenant databases.
Add a contributor page for regenerating and checking the samples, and
correct the release page's statement about private packages.
- Move the Chronicle, MongoDB, SQL, and proxy generation check
  descriptions into the capability reference and fix the PostgreSQL
  spec path
- Add rows for Chronicle compliance, reactor replay exclusion, and
  code analysis, and rename the Cratis composition row
- Add a glossary and a diagnostics reference
@woksin woksin added the no-release No consumer-facing artifact changes label Sep 25, 2026
@woksin
woksin merged commit 5389cdc into main Sep 25, 2026
3 checks passed
@woksin
woksin deleted the docs/batch-c branch September 25, 2026 06:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-release No consumer-facing artifact changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant