docs: refresh root README and write real client README#118
Merged
emal-avala merged 1 commit intomainfrom Apr 15, 2026
Merged
Conversation
Audited the repo against the README's claims and corrected stale counts: 18 bundled skills (was 12), 52 slash commands (was 43), 650+ tests (was "225+"). Added the six skills shipped since the last update (changelog, release, benchmark, coverage, migrate, docs) and surfaced /uninstall in the slash-command highlights. Architecture diagram now includes crates/eval, packages/agent_code_client, and client/ so the Flutter front-end is discoverable from the entry doc. Replaced the one-line client/README.md stub with a real doc covering purpose, relationship to the CLI, supported platforms, the Flutter stack, FVM-based quickstart, the three test surfaces (unit, Flutter integration, Playwright e2e), and the directory layout.
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
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.
Summary
/changelog,/release,/benchmark,/coverage,/migrate,/docs) and surfaced/uninstallin the slash-command highlights.crates/eval,packages/agent_code_client, andclient/so the Flutter front-end is discoverable from the entry doc.client/README.mdstub with a real doc: purpose & relationship to the CLI, supported platforms (macOS/Linux/web), Flutter stack (3.41.6 pinned via.fvmrc,flutter_bloc, localagent_code_clientpackage), FVM-based quickstart, the three test surfaces (unit / Flutter integration / Playwright e2e inclient/e2e/), and the directory layout.Test plan
client/quickstart on a fresh clone (fvm install && fvm flutter pub get && fvm flutter run -d macos).crates/lib/src/skills/mod.rs,crates/cli/src/commands/mod.rs, andgrep -rE "#\[(tokio::)?test\]" crates/ | wc -l.