Skip to content

Redo README against the current app, fix public config route - #9

Merged
Ben-K-Jordan merged 1 commit into
mainfrom
claude/session-link-generation-SCkSf
Jul 17, 2026
Merged

Redo README against the current app, fix public config route#9
Ben-K-Jordan merged 1 commit into
mainfrom
claude/session-link-generation-SCkSf

Conversation

@Ben-K-Jordan

Copy link
Copy Markdown
Owner

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

  • All screenshots and the answer-loop GIF recaptured from the current UI (the old set showed the 7-link nav, the mid-session score tally, and the pre-redesign dashboard). 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. Unused signin.png deleted.
  • Corrected the one outright false claim: the old README praised the next question loading above the previous answer's feedback; that behavior was removed deliberately (the review now snapshots the answered question). The copy now describes the current design.
  • Stale claims fixed: e2e runs against your dev server locally and a production build only in CI; admin is API-only (no /admin pages); the layout section now mentions src/ui and scripts; db:down stops the whole compose stack; the references list drops one work the body never cited.
  • New features documented: Learn page recommendations with one-tap session start, follow-up scheduling from the end screen, the persistent plan view with countdown and same-course replacement, plan reflow, chat with citations, study guides, auto sign-in after signup, timezone detection, and the four-destination navigation with the receding in-session variant.
  • Configuration section now documents REQUIRE_EMAIL_VERIFICATION.
  • Prose remains free of dash characters (verified; the only hyphens are inside literal code identifiers).

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/config returns 200 with flags while /api/settings still returns 401.

Verification

  • tsc --noEmit clean, 646 unit tests passed
  • Full e2e after production rebuild: 57 passed, 15 skipped (baseline)
  • README dash audit clean; all referenced images exist

Generated by Claude Code

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.
@Ben-K-Jordan
Ben-K-Jordan merged commit a797373 into main Jul 17, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants