docs: reviewer-facing README, ASSUMPTIONS, and DB migration guide - #14
Merged
Conversation
Close #7. Deliver the documentation the brief mandates: - README: stack rationale, layered architecture (routes → domain → repository + pure functions), full quickstart/scripts, endpoint reference with params + Swagger /docs link, testing strategy, and a dedicated Use-of-AI section (incl. where judgment stayed human). - ASSUMPTIONS.md: every deliberate decision + why — nights-vs-days availability, dataset-as-source-of-truth (past-dated windows), price_from = cheapest room, price filtering independent of availability, exact star match, no pagination, {data}/{error} envelopes, snake_case wire, no auth, USD assumption, "free Wi-Fi" data quirk, the Pact "know when not to" note, and Docker rationale. - docs/migration-postgres-sqlite.md: the repository-swap guide, now referenced by ADR-0001. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Closed
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.
Closes #7.
Delivers the reviewer-facing documentation the brief mandates.
What's here
/docslink, testing strategy, and a dedicated Use of AI section (with a "where judgment stayed human" subsection).price_from= cheapest room, price filtering independent of availability, exact star match, no pagination,{data}/{error}envelopes, snake_case wire, no auth, USD assumption, the"free Wi-Fi"data quirk, the Pact "know when not to" note, and Docker rationale.Verification
npm run verify(typecheck → lint → test): clean, 54/54 pass.hotel-01, 2026 dates).🤖 Generated with Claude Code