docs: add a Running section to README (tests + IR visualization) - #176
Merged
Merged
Conversation
Adds a ## Running section after ## Building that documents how to exercise the workspace now that there's no bin/ crate yet: - cargo test --workspace - cargo run -p asap-lower --example topk_ir to pretty-print the L3 QueryExpr IR for a batch of PromQL/SQL queries, with a real sample of the output and a pointer to docs/l3-intent-algebra.md Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Resolve conflict from README.md's simplification on main (dropped the Troubleshooting and Key design references sections) by keeping that trim and re-anchoring the new Running section on top of it. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Removed instructions for visualizing a query in README.
3 tasks
zzylol
added a commit
that referenced
this pull request
Aug 12, 2026
…by a stale squash-merge (#177) PR #176's squash-merge (via gh pr merge) used a stale cached PR head on GitHub's side and landed the pre-#134-merge content: the README still had the topk_ir/{:#?} section, and none of #134's actual files (crates/ir/src/dag_export.rs, crates/lower/examples/dag_export.rs, tools/dag-viewer/) made it into main. This restores exactly the tree that was actually reviewed and verified (build/test/clippy clean, dag_export CLI run end-to-end) before the merge: the query-DAG JSON exporter + offline HTML viewer (#134, with the Aggregate::by -> reduction compile fix), and the README's 'Visualize the IR' section pointing at it instead of topk_ir. Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
3 tasks
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
## Runningsection to the README right after## Building, covering how to actually exercise the workspace's artifacts today (there's nobin/crate yet).cargo test --workspacefor the test suite.cargo run -p asap-lower --example topk_irfor visualizing the L3 IR — includes a real (verified by running it) sample of the pretty-printedQueryExproutput fortopk(5, rate(http_requests_total[5m])), plus a pointer todocs/l3-intent-algebra.mdand how to point the example at a custom query.Verification
Ran both commands locally against this branch to confirm they work and to capture real output for the README snippet (
cargo test --workspacepasses;cargo run -p asap-lower --example topk_irproduces the pasted tree).🤖 Generated with Claude Code