docs(readme): refresh intro, engine/backend support, and doc index#148
Open
EdHasNoLife wants to merge 2 commits into
Open
docs(readme): refresh intro, engine/backend support, and doc index#148EdHasNoLife wants to merge 2 commits into
EdHasNoLife wants to merge 2 commits into
Conversation
- Add a conceptual on-ramp: what the project is (a cache-policy control plane, not a new cache/gateway), the 'we decide routing; the gateway follows' principle, and a one-request end-to-end flow; point to docs/concepts/. - Add an 'Engines and backends' section: vLLM + LMCache/External supported today; SGLang (MP mode) and Mooncake (mesh) in active development. The README was LMCache-only. - The six v1alpha1 CRDs have all landed (drop 'as they land'). - Generalize the webhook description from 'LMCache engine configuration' to 'per the matched runtime adapter'. - Refresh the Documentation section to point at the real docs/ tree (concepts, design, reference, operations, observability, reference-stack, quickstart).
Codex reviewFiles reviewedRoot:
FindingsBlockingNone. Should-fixREADME.md:27 — Replace nonexistent README.md:28 — Mooncake is incorrectly categorized as “in active development.” The current tree implements and registers the vLLM/Mooncake adapter, reconciles its managed workload, and provides a runnable sample; the README should describe its actual support status and any remaining limitations. NitNone. Per-category coverage
Verdictchanges-requested |
heymrbox
approved these changes
Jul 15, 2026
Codex reviewFiles reviewed
FindingsBlockingNone. Should-fix
NitNone. Per-category coverage
Verdictchanges-requested |
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.
Bring the public README up to date. Docs-only; independent of the in-flight SGLang/Mooncake PRs (touches only
README.md).docs/concepts/.docs/tree (concepts, design, reference, operations, observability, reference-stack, quickstart) instead of 3 design docs.All links verified to resolve; no naming/leakage.