docs: add comprehensive echo technical teardown#384
Conversation
|
Warning Review limit reached
More reviews will be available in 50 minutes and 19 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 718825c268
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| ### `main.rs`: command parsing and dispatch | ||
|
|
||
| The true startup boundary is the CLI executable entrypoint in [`crates/warp-cli/src/main.rs`](/Users/james/git/echo-teardown/crates/warp-cli/src/main.rs). |
There was a problem hiding this comment.
Replace local absolute source links
When this page is rendered by VitePress or browsed on GitHub, this /Users/james/git/echo-teardown/... target is treated as a site-absolute link to the author's local checkout rather than a repository file. I ran pnpm docs:build and VitePress reports dead links for every one of these references in technical-teardown.md, so readers cannot navigate the source references unless they are changed to repo-relative links such as ../crates/... or plain relative Markdown targets.
Useful? React with 👍 / 👎.
| - `echo verify <snapshot> [--expected <hex>] [--format json|text]` | ||
| - `echo inspect <snapshot> [--tree] [--raw]` | ||
| - `echo wal doctor <root>` | ||
| - `echo wal submission-posture <root> <submission_id> <submission_digest>` | ||
| - `echo bench [--filter <regex>] [--baseline <path>]` |
There was a problem hiding this comment.
Use the actual echo-cli syntax
These copy-paste examples use echo, but the binary and Clap command name are echo-cli, and submission-posture takes --submission-id and --canonical-envelope-digest flags rather than two positional values (crates/warp-cli/src/cli.rs defines those fields with #[arg(long)]). Anyone following this appendix will hit command-not-found or Clap argument errors for the WAL posture path, so the examples should match the real CLI shape.
Useful? React with 👍 / 👎.
Summary
Add a full technical teardown in
docs/technical-teardown.mdcovering:verify,inspect,wal, andbenchNotes
This commit is documentation-only and is intentionally exhaustive for zero-to-hero onboarding into the Echo/Warp runtime.