Repository navigation
chore(docs): add a guide and example for the smallest valid event model - #213
Conversation
Signed-off-by: Erik Nilsen <enilsen16@live.com>
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configuration
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
PR SummaryLow Risk Overview A new how-to walks through eight steps—from problem space through Docs index and Reviewed by Cursor Bugbot for commit e68bfdc. Bugbot is set up for automated code reviews on this repo. Configure here. |
Problem
Atlas has 29 entity kinds. The docs give no smallest valid model and no order to create entities in, so a new author does not know where to start.
Change
docs/how-to/start-a-model-from-scratch.md. It gives the order (problem space, swimlane, event and command, persona and UI, command slice, read model and slice, storyboard, event model), the fields the validator checks for each kind, and the rule code behind each check. Each rule comes from the rule catalog, the validator, or the MCP server instructions.acme-wishlistexample namespace that the guide builds: one human-issued command, one event, one read model, and one storyboard.docs/README.mdandexamples/manifests/README.md.acme-wishlisttoNAMESPACESinexample_manifests_validate.rs, so CI checks that the namespace validates with no errors or warnings.Test
cargo test -p trogon-atlas-server --test example_manifests_validatepasses. Withpersonaremoved from the command slice, it fails withCOMMAND_HAS_NO_TRIGGER.cargo test -p trogon-atlas-cli --test fmt_integrationand themanifest_schematests pass.trogon-atlas fmt --checkreports no change foracme-wishlist.trogon-atlas apply --dry-runpasses after each step of the guide.Closes #83
Need help on this PR? Tag
@codesmith-botwith what you need.