Repository navigation
docs: close the credibility gap before submission - #149
Merged
Merged
Conversation
Third-party review flagged a mismatch: the codebase reads "serious engineer", but two visible-on-day-one bits still read "unfinished scaffold." Four fixes, all reading-only: 1. Landing page footer (frontend/app/page.tsx) Replaced "Phase 2 scaffold — auth pages arrive in the next PR" with a demo credentials hint. Also dropped the stale comment above the Sign-in / Create-account buttons claiming the routes are non-functional placeholders — they ship and work. 2. frontend/README.md The old version listed P2.9b/P2.9c/P2.10 as "📋 not yet" with a status table that was four PRs out of date. Rewritten to describe the routes actually shipped (auth + dashboard + generate + improve + brand-voices + settings + usage), the actual auth model (in-memory access token + httpOnly refresh cookie + 401 interceptor + queryClient.clear on logout), the `NEXT_OUTPUT=export` build path used for current manual deploys, and the real component/lib layout. 3. README headline "production-grade SaaS" → "production-minded SaaS demo". Single- token swap that keeps the framing strong while not inviting a reviewer to attack the known demo compromises (public RDS, local image storage, deferred ElastiCache — all documented honestly in ARCHITECTURE.md). 4. README "For reviewers" section New unnumbered section between §1 Live demo and §2 What it does. Bullets the load-bearing engineering signal: provider abstraction, three-stage parse fallback, custom JWT, async repo architecture, CI gates, CDK infra, honest trade-offs, living devlog. Plus a suggested reading order pointing at ARCHITECTURE.md and the "What I'd add next" section. Verification pnpm lint no ESLint warnings or errors pnpm format:check clean pnpm typecheck clean pnpm test 28 passed (unchanged — no behaviour change) pnpm build compiled successfully
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.
Summary
Third-party review flagged a mismatch: codebase reads "serious engineer" but two visible bits — landing page footer and `frontend/README.md` — still read "unfinished scaffold." This PR fixes the visible mismatch without changing any behavior.
Why
Reviewer's "credibility mismatch" framing was correct. A reviewer skimming the live demo first hits the landing page; if it says "Phase 2 scaffold," the rest of the polished README gets discounted. The fix is two-line file edits with zero runtime risk.
Verification