Repository navigation
fix(server): state the rule instead of a decision number in kind and rule docs - #209
Conversation
…rule docs 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 Reviewed by Cursor Bugbot for commit c0089d0. Bugbot is set up for automated code reviews on this repo. Configure here. |
Problem
Six kind docs and rule docs cite a design decision by number only, for example "Decision #27: slug == namespace." Agents get these docs from
list_entity_kindsandlist_validation_rules. No list of decisions exists that an agent can read, so a bare number tells the agent nothing. TheSchemakind doc cites "Decision #33." and gives no rule at all.Change
SharedConsumersAnnotationwhen one read model serves several on purpose.SLICE_STALE_REF,CONTEXT_SLUG_MISMATCH: the rule was already in the text. The change removes the number.SEAM_WITHOUT_RELATIONSHIP: declare the relationship on the downstream context, so the relationship intent and the seam data agree.A full decisions document stays with the maintainer. Only the maintainer knows what each number originally said, and the proto has no list to generate it from.
Test
tests/catalog_docs.rschecks that no entity kind doc and no validation rule doc contains "Decision #". It failed on the six docs before the change and passes after it.cargo test -p trogon-atlas-serverpasses.cargo clippy -p trogon-atlas-server --all-targets -- -D warningsis clean.Closes #82
Need help on this PR? Tag
@codesmith-botwith what you need.