Repository navigation
docs: correct stale setup and testing guidance - #105
Merged
Merged
Conversation
AGENTS.md and README.md still described SQLite, node:test, test/auth, test/routes and test/components, port 3000, a /demo redirect whitelist, and magic links as console-only. The app runs on PostgreSQL, the suite uses tap, the test directories are features, unit and integration, the app listens on 3001, allowed redirects come from PLANNER_REDIRECT_URIS, and production magic links go through SendGrid. Line references in the architecture notes now point at the current code.
mroderick
marked this pull request as ready for review
November 11, 2026 16:29
till
approved these changes
Nov 11, 2026
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.
AGENTS.md tells a new contributor to use
node:test, a SQLite database, port 3000, and three test directories that do not exist. README.md repeats the SQLite and port claims. Both now match the code.What was wrong, and what it says now:
./auth.dbanywhere in the file. The app has used PostgreSQL only since the migration;DATABASE_URLdefaults topostgres://auth:auth@localhost:5433/test.node:testandnode:assert. All 16 test files usetap, and.taprcsetsallow-incomplete-coverage: true, so the four invented coverage thresholds are gone too.test/auth/,test/routes/,test/components/and atest/helpers/app.jsthat does not exist. The real layout istest/features/,test/integration/,test/unit/and three helpers.AUTH_DEFAULT_PORT); 3000 is the planner.["http://localhost:3000/demo"]whitelist atconfig.js:6. It isPLANNER_REDIRECT_URIS, defaulting to the planner callback./api/test/magic-linksroute are development only.src/auth/,src/dev/andsrc/app/db/.One addition:
preteststarts the container withapple/container, which is macOS-only, sonpm testfails at that step on Linux. The file now says to start PostgreSQL yourself and runnpx tap.Review notes
Every claim in the diff was checked against the source rather than rewritten from memory:
src/config.jsfor ports, defaults and redirects,src/auth.jsandsrc/app/app.jsfor line references,package.jsonand.taprcfor the test setup, and a test run for the stderr messages the Testing section now lists.docs/plans/still contains design documents that describe SQLite. Those are dated records of past decisions, not guidance, so they are untouched.