docs: add explicit Data model section to README - #17
Merged
Conversation
The submission brief asks the README to explain "architectural choices and data modeling." Architecture was covered but the data model was only implicit (CONTEXT.md + the Zod schemas). Add a dedicated "Data model" section: the Property→Rooms nested aggregate and its fields, the derived-not-stored values (price_from, nights, total_price), and the Zod-schema-as-single-source-of-truth (validates the seed, infers the domain types). No code change. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Adds a dedicated Data model section to the README, so the submission explicitly covers the brief's "architectural choices and data modeling" (previously the data model was only implicit in
CONTEXT.mdand the Zod schemas).Covers: the Property→Rooms nested aggregate and its fields, the derived-not-stored values (
price_from,nights,total_price), and the Zod-schema-as-single-source-of-truth (validates the seed at load time, infers the domain types). Docs only — no code change.🤖 Generated with Claude Code