Redo README against the current app, fix public config route - #9
Merged
Conversation
The README is rewritten to match the app as it exists after the slim down and the focus pass. Every screenshot and the answer loop GIF are recaptured from the current UI, including two new images: the plan view with its exam countdown and dated sessions, and the end screen with calibration and one tap follow up scheduling. The copy that praised the old review screen behavior (next question shown above the previous answer's feedback) is replaced with the current design, the review snapshot. Stale claims fixed: e2e runs against the dev server locally and a production build in CI, admin is API only with no UI pages, and the layout section now mentions src/ui and scripts. New sections cover the Learn recommendations, chat with citations, study guides, plan reflow, and account tools, and the configuration list documents REQUIRE_EMAIL_VERIFICATION. The references list drops one work the body never cited. Prose stays free of dash characters. Also fixes a bug the recapture surfaced: /api/config was blocked by the auth middleware, so the signup page's probe got a 401 and auto sign in silently fell back to the verify email screen. The route only returns non secret flags and is now public.
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.
Full README redo, driven by a fact-check of every claim against the code and a fresh capture session against the current UI.
What changed
signin.pngdeleted./adminpages); the layout section now mentionssrc/uiandscripts;db:downstops the whole compose stack; the references list drops one work the body never cited.REQUIRE_EMAIL_VERIFICATION.Bug fix included
The recapture surfaced a real bug:
/api/config(non-secret runtime flags) was blocked by the auth middleware, so the signup page's probe got a 401 and the new auto sign-in silently fell back to the verify-email screen for fresh visitors. The route is now on the middleware's public list. Verified live: unauthenticated/api/configreturns 200 with flags while/api/settingsstill returns 401.Verification
tsc --noEmitclean, 646 unit tests passedGenerated by Claude Code