docs(showcase): rebuild Reva README and docs#58
Merged
Conversation
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
docs/assets/showcase/.Root cause
The prior README was technically useful but not showcase-ready on GitHub mobile: the hero image did not use the app logo, capability tables were dense, and Mermaid diagrams rendered as raw code in the mobile view Tony reviewed.
Changes
README.md: new app-logo header, concise product narrative, marketing screenshot showcase, non-programmer capability table, quick start, packaging summary, and docs index.docs/product-guide.md: new plain-English workflow guide for non-programmers and interviewers.docs/index.md: rebuilt documentation map and constraints without Mermaid blocks.docs/architecture.md: rewrote boundaries, runtime flow, contracts, and scaling path.docs/ai-pipeline.md: rewrote deterministic pipeline, learned mapping, optional model assist, and assistant tool loop.docs/demo-script.md: rewrote interview walkthrough and talk track.docs/packaging.md: clarified development, packaged mode, runtime data, and validation.docs/learn/*.md: rewrote interview cheatsheet, code tour, tech stack, and model landscape.docs/research/reinsurance-landscape.md: rewrote domain context in product-friendly language.docs/assets/reva-logo-*.png: copied the real app logo variants for README rendering.docs/assets/showcase/*.png: added clean live app screenshots and marketing-card derivatives.docs/assets/reva-banner.png: removed stale generated banner.Proof
pnpm buildinweb/passed: Next.js 16.2.9 compiled, TypeScript completed, and 11 static pages generated.git diff --checkpassed.reva-banner.pngreferences, and no raw Mermaid code blocks remain.http://localhost:3000with onboarding disabled and API data fromhttp://localhost:5158.Acceptance
docs/assets/reva-logo-dark.pnganddocs/assets/reva-logo-light.png.Closes #57