docs: trim the README to a tight spine (611 → 346 lines) - #106
Merged
Merged
Conversation
The README had grown into docs: a 25-item changelog, the full competitive matrix, the sleep-mode sequence diagram, every API/TP/S3/SGLang/CLI variant, and an ASCII repo tree — all duplicating docs/. Restructured to a tight, always-visible spine (pitch -> demo -> verbs -> receipts -> who -> how-fork- works -> architecture -> one quickstart -> contact) with the reference-heavy material collapsed into <details> or linked to the docs that already hold it. - Drop the 493 KB rewind gif embed (kept the demo gif + a link to the rewind validation doc); drop the ASCII tree (the architecture map + docs/ARCHITECTURE.md cover it). - Collapse server/Python/TP/S3/SGLang/LangGraph/CLI usage, demos, and troubleshooting into <details> — content preserved, length hidden. - Summarize the competitive matrix and the changelog; link docs/LANDSCAPE.md and the new roadmap board. - Fix a broken link: DESIGN.md (doesn't exist) -> docs/ARCHITECTURE.md. - Re-add the production demo videos as a one-line link row. All validated receipts preserved verbatim; every local link resolves; thaw-lint clean.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe README now opens with a 10-second demo section, rewrites audience and performance messaging, shortens the restore explanation, replaces the quick-start and feature-tour content, and refreshes the demos, comparison, roadmap, troubleshooting, and contact sections. ChangesREADME refresh
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
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
1 participant
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.
The README had grown into docs. Restructured to a tight always-visible spine (pitch → demo → verbs → receipts → who → how-fork-works → architecture → one quickstart → contact); the reference-heavy material is collapsed into
<details>or linked to the docs that already hold it.docs/ARCHITECTURE.md).<details>: server mode, Python API, multi-GPU, S3, SGLang, LangGraph, CLI reference, demos, troubleshooting — content preserved, length hidden.docs/LANDSCAPE.md; the 25-item changelog → a 2-line shipped/next + the roadmap board.DESIGN.md(doesn't exist) →docs/ARCHITECTURE.md.All validated receipts preserved verbatim; every local link resolves; thaw-lint clean.
Summary by CodeRabbit