Add docs and a Makefile, and bring local Postgres to 17 - #68
Merged
Merged
Conversation
docs/ holds development, architecture, judge and sandbox, and self-hosting pages, plus decision records. Pages name the file or constant that holds a value instead of copying it, decision records are append-only, and a CI job fails on any relative Markdown link that no longer resolves. Also for contributors: a Makefile for the everyday commands, issue forms, SECURITY.md, Dependabot (monthly, grouped, monaco-editor held), an editorconfig, a Node version file, a documented web .env.example, and a docs prompt in the pull request template. Local Postgres was 13 while CI and production run 17. It is now 17 on a volume named for the version, so an existing 13 volume is left alone instead of failing to start.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Warning Review limit reachedNext included review available in 44 minutes. View limit detailsLimit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Review configuration: ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (26)
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 |
The site, API, Vercel deployment, both CI workflows and the license. The API badge reads /health's JSON, because the plain website badge sends HEAD and /health answers GET only.
This branch was successfully deployed
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.
What and why
The public docs were removed in #56 because they had gone stale. This adds them back, built to stay current:
docs/README.mdindexes the pages and states the rules: pages name the constant or file that holds a value instead of copying it, link files rather than lines, change in the same PR as the behaviour, and decision records are append-only.docs/development.md,architecture.md,judge-and-sandbox.md,self-hosting.md, anddocs/decisions/with four records (one backend host, a container per run, the editor relay, problems as migrations).Docsworkflow runs lychee offline over every Markdown file, so a moved or deleted file fails CI.Contributor setup:
Makefile:setup,up,down,logs,web,test,lint,check,smoke. AGENTS.md and CONTRIBUTING.md now point at it.SECURITY.mdwith scope.monaco-editorat its pin..editorconfig,apps/web/.nvmrc(22, as in CI), andapps/web/.env.templaterenamed to a commented.env.examplethat includesVITE_BACKEND_URL.Local Postgres moves from 13 to 17 to match CI and production. The volume is now
tandemcode-db-data-17, so an existing 13 volume is left untouched rather than failing to start; local data starts empty once.How this was verified
make test: 128 passed, 5 skipped, on Postgres 17.11 in the compose database.make lint: web lint and build pass.make upthenmake smokeagainst production: all checks ok.Docs
This is the docs change.