docs: document the Docker and compose workflow in the runbook - #44
Merged
Conversation
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 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 |
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.
Follow-up to #18, found by auditing the public docs against what actually shipped today.
The gap
grep -ci docker README.md RUNBOOK.mdreturned 0 for both. #18 landed a multi-stageDockerfile, a.dockerignore, and adocker-compose.ymlthis morning, and neither file mentioned any of it. For contrast, #9's Render fallback was documented in the same sweep — 34 mentions inRUNBOOK.md.Since
docs/is git-excluded,README.mdandRUNBOOK.mdare the entire public documentation surface. A contributor cloning the repo would find a Dockerfile with no instructions anywhere.Added
RUNBOOK.md§2.1 "Run locally with Docker (optional)" — placed under Clone and install because compose is primarily a local-dev path, so no section renumbering and no TOC churn. Covers the three-command quickstart, what compose does (prisma migrate deploybefore start, mirroring theProcfilerelease phase), teardown, and a validation checkpoint matching the file's existing style.It also records the three things that actually cost time when this was built and verified:
NODE_ENV: productionis pinned underenvironment:deliberately, becauseenvironmentbeatsenv_fileand the repo.envshipsNODE_ENVempty. Without it the API answers but the SPA 404s, since theexpress.staticbranch inapp.tsnever runs.P1001) on retry;docker compose down -vclears it.README.md— one row in the commands table pointing at the new section.Verified
Every
RUNBOOK.mdTOC anchor still resolves · all 11pnpmcommands in the README's table exist inpackage.json· Prettier clean.https://claude.ai/code/session_01URDpaxhXyPLWnUQtvowNyM