docs(readme): T-135 Sprint 1 quickstart + smoke probe (closes #49)#67
Merged
Conversation
) - Replace generic Setup with "Quickstart" section: clone, install-hooks, `pnpm exec tauri dev` boot flow targeting the ARCHI.md §23 onboarding criterion (< 5 min on a fresh clone). - Add "Verify the Sprint 1 smoke flow" subsection mirroring `scripts/smoke-e2e.sh` (pilot-gated dev server + `tauri-pilot ipc tasks_list --args '{}'` probe with the v0.5 `--args` form, not the v0.4 positional `'{}'` referenced in the issue body). - Add "What works in Sprint 1" section enumerating the landed deliverables (hexagonal layout, libsql + V001, `AppContainer::build`, `tasks_list` IPC, `TauriEventPublisher`, `tracing` redaction, Sidebar/WelcomeScreen, Zustand `useTaskStore`, i18n FR+EN, codegen-types, llvm-cov 75 gate, smoke E2E gate) so the README delta after Sprint 0 is visible without diffing CHANGELOG. - Add explicit link "ARCHI.md §4 — Layout du repo" (GFM anchor `#4-layout-du-repo`) for full architecture rationale. - Pin `tauri-pilot-cli` install hint to `=0.5.1 --locked` to match `tauri-plugin-pilot = "0.5.1"` in `src-tauri/Cargo.toml` (same hardening rationale as PR #66 CodeRabbit fix). - Add Smoke E2E badge alongside CI / Release / CodSpeed. - Update Status line from "Sprint 0 closure" to "Sprint 1 closure — smoke E2E gate green on main". - Replace pre-existing broken `[AGPL-3.0](LICENSE)` link with the canonical `gnu.org/licenses/agpl-3.0` URL (no `LICENSE` file in repo; matches the badge target). Adding the file itself is out of scope. CHANGELOG `[Unreleased]` already enumerates Sprint 1 additions (130 entries, verified each spec-required entry present: hexagonal, AppConfig, ensure_dirs, tracing redaction, libsql V001, domain/tasks, EventPublisher, AppContainer, tasks_list, codegen-types, Sidebar/WelcomeScreen/useTaskStore/i18n, UI primitives, llvm-cov gate). No CHANGELOG change needed. Tests: doc-only (per T-135 spec).
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughREADME updated to mark Sprint 1 closure: new Smoke E2E badge and status line, expanded dev tooling and Smoke/E2E prerequisites, rewritten Quickstart with install-hooks and tauri-pilot IPC verification, a detailed Sprint 1 feature checklist, an explicit hexagonal architecture rule, and AGPL-3.0 license link. ChangesSprint 1 Documentation Update
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related issues
Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Review Summary by QodoDocument Sprint 1 quickstart, smoke E2E flow, and deliverables
WalkthroughsDescription• Add Sprint 1 quickstart section with 5-minute fresh clone boot flow • Document smoke E2E verification steps using tauri-pilot ipc tasks_list • Enumerate Sprint 1 deliverables (hexagonal layout, libsql, IPC, event bus, tracing, frontend skeleton, codegen, quality gates) • Add Smoke E2E badge and update status line to reflect Sprint 1 closure • Pin tauri-pilot-cli to v0.5.1 and fix broken AGPL license link Diagramflowchart LR
A["README.md"] -->|Add Quickstart| B["Fresh Clone Boot"]
A -->|Add Smoke Flow| C["IPC Verification"]
A -->|Document Sprint 1| D["Deliverables List"]
A -->|Update Status| E["Sprint 1 Closure"]
A -->|Add Badge| F["Smoke E2E CI"]
A -->|Fix Links| G["License + ARCHI"]
File Changes1. README.md
|
Code Review by Qodo
1.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 43-44: The Quickstart mentions running ./scripts/install-hooks.sh
and pnpm exec tauri dev but doesn’t guide Windows users; update the README entry
around those lines to add a short note telling Windows users to run the
install-hooks.sh step in Git Bash or WSL (or alternatively provide a one-line
PowerShell equivalent for running the script and invoking pnpm, e.g., how to run
the hook installer and pnpm command in PowerShell) so Windows onboarding is
explicit and non-blocking.
- Around line 51-56: Clarify the execution order by updating the comments around
the two commands so they explicitly label the terminals and avoid "instead of"
wording: change the comment before "pnpm exec tauri dev --features pilot" to
"terminal 1: pilot-gated dev server" (for the pilot app), and change the comment
before "tauri-pilot ipc tasks_list --args '{}'" to "terminal 2: probe the first
IPC command" so users know to run the dev server in one terminal and the IPC
probe in a second; adjust surrounding text to reflect that the app must be
running in terminal 1 before executing the tauri-pilot IPC command in terminal
2.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
1 issue found across 1 file
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="README.md">
<violation number="1" location="README.md:89">
P2: This new internal link points to `ARCHI.md`, but that file does not exist in the repository, so readers hit a broken link.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
![qodo-code-review[bot]](https://avatars.githubusercontent.com/in/484649?s=60&v=4){kind=small}
Contributor
- Windows shell note for `./scripts/install-hooks.sh` (run via Git Bash or WSL; PowerShell/cmd.exe will not execute the bash script). Per CodeRabbit comment on L44.
- Reword smoke verification block: explicit "terminal 1" / "terminal 2" labels, drop the ambiguous "instead of" phrasing. Apply CodeRabbit suggested diff on L56 verbatim.
- Correct CI trigger claim: `.github/workflows/smoke-e2e.yml` is `workflow_dispatch` only — README previously said "runs in CI on every push" which is wrong. Per qodo finding on L61.
- Drop links to `ARCHI.md` (`§23` onboarding ref + `§4` architecture link) and `PRD.md` (roadmap ref) because both files are intentionally gitignored at `.gitignore:55-56` ("Specs"). Cubic and qodo correctly flagged the broken internal links. The "Architecture" section now inlines the dependency rule + composition-root invariants that previously lived behind the ARCHI.md §4 link, so the design rationale is still surfaced without depending on a local-only spec file.
T-135 spec mentioned an `ARCHI.md §4` link as a sub-criterion, but that pre-dated the deliberate gitignore policy on the specs files. Honoring the gitignore wins — the AC "no broken markdown link" is the stronger constraint.
This was referenced May 11, 2026
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
clone → ./scripts/install-hooks.sh → pnpm exec tauri dev) targeting ARCHI.md §23 onboarding (< 5 min fresh clone).scripts/smoke-e2e.sh(pilot-gated dev server +tauri-pilot ipc tasks_list --args '{}'— note the v0.5--argsform, not the v0.4 positional'{}'referenced in the issue body).AppContainer::build,tasks_listIPC,TauriEventPublisher,tracingredaction, Sidebar/WelcomeScreen, ZustanduseTaskStore, i18n FR+EN, codegen-types, llvm-cov 75 gate, smoke E2E gate).ARCHI.md §4 — Layout du repo(GFM anchor#4-layout-du-repo).tauri-pilot-cliinstall hint to=0.5.1 --locked(matchestauri-plugin-pilot = "0.5.1"insrc-tauri/Cargo.toml, same hardening rationale as PR feat(ci): Sprint 1 smoke E2E + tauri-pilot wiring (T-134) #66).[AGPL-3.0](LICENSE)link withhttps://www.gnu.org/licenses/agpl-3.0(noLICENSEfile in repo; matches badge target). Adding the actualLICENSEfile is out of scope.Why
Closes the Sprint 1 documentation gate. CHANGELOG
[Unreleased]already enumerated all 130 Sprint 1 entries (verified each spec-required entry present via grep: hexagonal, AppConfig, ensure_dirs, tracing redaction, libsql V001, domain/tasks, EventPublisher, AppContainer, tasks_list, codegen-types, Sidebar/WelcomeScreen/useTaskStore/i18n, UI primitives, llvm-cov gate). Only the README delta remained, blocked on T-134 which now landed via PR #66.Changes
README.md— rewrite (+42 / -6).CHANGELOG.md— no change (already complete).Acceptance criteria (T-135)
scripts/install-hooks.shexists,pnpm exec tauri devvalid, smoke probe matchesscripts/smoke-e2e.sh:140,191,tauri-pilot-clipin matches Cargo manifest).[Unreleased]lists all Sprint 1 additions — verified spec-required entries present.ARCHI.md,package.json,rust-toolchain.toml,scripts/smoke-e2e.sh) exist; pre-existing brokenLICENSElink replaced with canonical URL.Test plan
code-revieweragent): 2 Low + 1 Nit, Low chore(bootstrap): init pnpm manifest with Corepack pinning (task 04) #1 (style inconsistencypnpm taurivspnpm exec tauri) fixed in the same diff; Low chore(bootstrap): scaffold Tauri 2 + cleanup samples #2 (Corepackprepare→use) and Nit (install-hooks.shpnpm@9hint) flagged as out-of-scope follow-ups.git ls-filesconfirms each internal link target exists.#4-layout-du-repoverified against ARCHI.md heading## 4. Layout du repo.Dependencies
Out of scope (intentional)
LICENSEfile (separate housekeeping PR).scripts/install-hooks.shpnpm@9install hint (separate fix).usevspreparedeprecation (Node-version-dependent).Summary by CodeRabbit