feat(map): payload contracts in Communication and a mechanical schema pass in check (6.1.0) - #17
Merged
Merged
Conversation
… pass in check (6.1.0) Two exhaustiveness guarantees the docs claimed informally but never mandated: - 01-architecture's Communication section now requires the payload each channel carries in both directions - the named model/DTO where one exists, inline fields where none does - cited at the send and receive sites. A bare route list fails the checklist. - map check gains part 8, a grep-only schema pass: required frontmatter keys and required headings per generated file, counted toward the stale verdict; doctor mirrors it as check 9 with the map refresh as the repair. Minor version: the new required content makes existing chapters regenerate via the ordinary template-drift path, nothing breaks.
There was a problem hiding this comment.
Sorry @GentBajko, you've used your own review budget of 250,000 diff characters for the last 7 days.
You can request another review in 2 hours and 51 minutes by commenting @sourcery-ai review. Upgrade to get a review now.
Reviewer's GuideThis PR closes the communication-contract documentation gap by requiring bidirectional payload definitions and call-site citations, and adds an eight-part mechanical schema pass to map check (mirrored by doctor) that detects missing generated-file stamps or required chapter headings and routes repairs through map refresh; all six manifests are bumped to 6.1.0. Flow diagram for schema validation and repairflowchart LR
Check[map check] --> Schema[Schema pass]
Schema --> Frontmatter[Check generated-file frontmatter]
Schema --> Headings[Check chapter headings]
Frontmatter --> Verdict[Stale verdict]
Headings --> Verdict
Verdict --> Refresh[map refresh]
Refresh --> Regenerate[Regenerate against current template]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes the two gaps from asking "is the doc format guaranteed, down to every contract?":
01-architecture.md's Communication section now mandates the payload every HTTP/websocket/event/queue/stream channel sends and receives: the named entity or DTO from02-models.mdwhere one exists, inline fields (name, type, optionality) where none does, with send and receive sites citedfile:line. The checklist makes a bare route list fail the section, so an ad-hoc dict pushed to a broker is documented as the contract it is.map checkgains part 8, a mechanical schema pass (grep only, no judgment): every generated file checked for required frontmatter keys, every chapter for the required headings its topic defines. Findings count toward the stale verdict since a missing heading is template drift and a missing stamp breaks the refresh; the repair is the ordinarymaprefresh.doctormirrors it as check 9.Existing repos pick the new Communication requirement up through the template-drift path on their next refresh. Version 6.1.0 across the six manifests.
Summary by Sourcery
Strengthen reference trust checks by documenting communication payload contracts and validating generated documentation schemas.
New Features:
map check, with matching schema diagnostics indoctor.Enhancements:
maprefresh as the repair path.Build:
Documentation:
map checkanddoctorbehavior to include schema validation.