README revamp: fix broken commands, add demo GIF, correct competitor table, polished#173
Conversation
Update competitor table
pricing section
Replace Examples section with Samples (surface 70+ samples per HoP feedback)
Accuracy review — README revamp (PR #173)Reviewed against the live repo ( ✓ Verified accurate
✗ Bugs introduced by this PR (please fix before merge)1. Three dead links in the new "Next steps" block — the PR explicitly removes -- **[Run a custom evaluation](./examples/)** ➡️ score your own model on any benchmark
-- **[Gate CI/CD on eval results](./examples/ci-gate)** ➡️ `layerlens ci run --threshold 0.8` in your pipeline
-- **[Upload and evaluate agent traces](./examples/agent-traces)** ➡️ multi-step trace analysisReal paths:
Given the PR's own headline is "fix broken commands," dead links here are extra worth catching. 2. Self-inconsistent benchmark count
Pick one number and use it consistently across all three locations. ⚠ Worth re-checking (couldn't verify from source)
Light suggestions
Nice work overall on the compete fixes — both DeepEval and Langfuse updates landed accurately against their respective public docs. |
Address accuracy review: fix dead links, unify benchmark count, fix Samples nav anchor, de-claim GIF caption, update Quick Start to 1.8.0 SDK API
|
Pushed fixes
Ready for another review |
Summary
README revamp to fix several broken user flows, improve clarity, and tighten product positioning. All commands and code blocks were tested locally on a fresh macOS environment to confirm they work.
Substantive fixes (issues that would affect users)
stratix init, which doesn't exist in the SDK, and replaced it with the workingPublicClientflow.stratix initcommand. Replaced it with the actual working install, API key, and first-call sequence."layerlens[cli]"in install commands. It was failing in zsh (default macOS shell) because of the unquoted brackets.pythontopython3. Default macOS no longer ships apythonalias, so the original command was failing.PublicClientvsStratix, so users aren't confused whenpcappears in code before it's introduced.--extra-index-urlis now a GitHub callout instead of a line that's easy to skim past.Competitor table updates
Additions
samples/directory.