docs: enhance README with traversal directory, seek guide, and runtime compat#64
docs: enhance README with traversal directory, seek guide, and runtime compat#64flyingrobots merged 6 commits intomainfrom
Conversation
📝 WalkthroughWalkthroughThis PR updates documentation only: Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
Release Preflight
If you tag this commit as |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
554-578:⚠️ Potential issue | 🟠 MajorClose the existing bash fence before the new Seek section.
The section starting at Line 554 is still inside the CLI code block opened at Line 535, so GitHub will render the heading, prose, and examples as literal shell text instead of Markdown. Close the first fence after
git warp check, then open a new fence just for the seek commands.Suggested fix
# Check graph health, status, and GC metrics git warp check +``` ### Time-Travel (Seek) One of git-warp's most powerful features is the ability to query the graph at any point in its history without modifying your Git HEAD. ```bash # Jump to absolute Lamport tick 3 git warp seek --tick 3 @@ # Return to the present and clear the cursor git warp seek --latestWhen a seek cursor is active,
query,info,materialize, andhistoryautomatically show state at the selected tick.+```bash
Visualize query results (ascii output by default)
git warp query --match 'user:*' --outgoing manages --view
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 554 - 578, The README's Seek section is still inside the earlier bash code fence; close the first fence immediately after the `git warp check` example and then open a new triple-backtick fence for the Seek command examples so the `### Time-Travel (Seek)` heading and prose render as Markdown; specifically, update the area around the `git warp check` block and the `### Time-Travel (Seek)` / `git warp seek` examples to end the previous ```bash fence and start a fresh ```bash fence only for the seek commands and the final `git warp query` snippet.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@README.md`:
- Around line 554-578: The README's Seek section is still inside the earlier
bash code fence; close the first fence immediately after the `git warp check`
example and then open a new triple-backtick fence for the Seek command examples
so the `### Time-Travel (Seek)` heading and prose render as Markdown;
specifically, update the area around the `git warp check` block and the `###
Time-Travel (Seek)` / `git warp seek` examples to end the previous ```bash fence
and start a fresh ```bash fence only for the seek commands and the final `git
warp query` snippet.
- Change premature [13.1.1] CHANGELOG entry to [Unreleased] - Restore --clear-cache and --no-persistent-cache to seek docs - Fix orphaned code block for visualize example (missing opening fence) - Remove duplicate "seek cursor is active" sentence
- Close unclosed ```bash fence before ### Time-Travel heading (critical: entire seek section was rendering as literal code) - Remove duplicate "User Manual" link that pointed to same docs/GUIDE.md already linked as "Guide" in the same paragraph - Correct "NodeCrypto" to "WebCrypto" for Node.js runtime — CLI and WarpGraph use WebCryptoAdapter across all runtimes - Normalize list markers from `* ` to `- ` for consistency (8 items) - Replace bare "Cache management" comment with descriptive per-command comments matching the style of adjacent seek examples
flyingrobots
changed the title
Release Preflight
If you tag this commit as |
- Add Common Ancestors and Root Ancestors to Graph Traversal Directory - Update algorithm count from "11+" to 15 (matches actual public API) - Remove "Fixed" CHANGELOG section that described bugs introduced and corrected within this branch — never existed in a released version
Release Preflight
If you tag this commit as |
1 similar comment
Release Preflight
If you tag this commit as |
|
@coderabbitai Thanks for catching the unclosed code fence — good eye. ✅ Addressed in commits:
@coderabbitai review 🥕 |
|
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 332-346: Update the Architecture description to reflect the
correct algorithm count: change the `GraphTraversal` summary string to say "(15
algorithms, `nodeWeightFn`)" instead of "(11 algorithms, `nodeWeightFn`)" so the
`GraphTraversal` entry matches the 15 algorithms listed and implemented.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 746e559c-c2a1-4b21-b1ac-3f11bba4906a
📒 Files selected for processing (2)
CHANGELOG.mdREADME.md
🚧 Files skipped from review as they are similar to previous changes (1)
- CHANGELOG.md
| ### Graph Traversal Directory | ||
|
|
||
| git-warp includes a high-performance traversal engine with 15 deterministic algorithms: | ||
|
|
||
| | Category | Algorithms | | ||
| | :--- | :--- | | ||
| | **Search** | BFS, DFS, Shortest Path (Unweighted), Reachability | | ||
| | **Weighted** | Dijkstra (Weighted Shortest Path), A*, Bidirectional A* | | ||
| | **Analytical** | Topological Sort (Kahn's), Connected Components, Levels (DAG) | | ||
| | **Ancestry** | Common Ancestors, Root Ancestors | | ||
| | **Reduction** | **Transitive Reduction** (v13.1), **Transitive Closure** (v13.1) | | ||
| | **Critical Path** | Weighted Longest Path (DAG) | | ||
|
|
||
| All algorithms support `maxDepth`, `maxNodes`, and `AbortSignal` cancellation. | ||
|
|
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Count traversal algorithms in GraphTraversal implementation
echo "Searching for GraphTraversal algorithm implementations..."
# Look for method definitions in GraphTraversal class/module
rg -n -A 2 'class GraphTraversal|export.*GraphTraversal' --type=ts --type=js
# Search for public algorithm methods (common patterns)
rg -n -P '^\s*(public\s+)?(async\s+)?\w+(Path|Sort|Search|Component|Ancestor|Reduction|Closure|Level|Reachable)' \
--glob '**/GraphTraversal*' --glob '**/graph-traversal*' \
--type=ts --type=js -C 1Repository: git-stunts/git-warp
Length of output: 4198
🏁 Script executed:
# Check line 670 in README.md
head -n 670 README.md | tail -n 5Repository: git-stunts/git-warp
Length of output: 367
🏁 Script executed:
# Find all public methods in GraphTraversal.js
rg -n '^\s*async\s+\w+\(' src/domain/services/GraphTraversal.js | head -20Repository: git-stunts/git-warp
Length of output: 665
🏁 Script executed:
# Search for BFS and DFS specifically
rg -n 'async (bfs|dfs)' src/domain/services/GraphTraversal.jsRepository: git-stunts/git-warp
Length of output: 98
🏁 Script executed:
# Get total line count of GraphTraversal.js to understand file structure
wc -l src/domain/services/GraphTraversal.jsRepository: git-stunts/git-warp
Length of output: 105
Update line 670 in Architecture section: algorithm count is 15, not 11.
The Graph Traversal Directory table (lines 332-346) correctly lists 15 algorithms, and the GraphTraversal.js implementation confirms all 15 exist. However, line 670's Architecture description still states "11 algorithms" and must be updated to match.
Update line 670 from:
`GraphTraversal` -- unified traversal engine (11 algorithms, `nodeWeightFn`)
to:
`GraphTraversal` -- unified traversal engine (15 algorithms, `nodeWeightFn`)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 332 - 346, Update the Architecture description to
reflect the correct algorithm count: change the `GraphTraversal` summary string
to say "(15 algorithms, `nodeWeightFn`)" instead of "(11 algorithms,
`nodeWeightFn`)" so the `GraphTraversal` entry matches the 15 algorithms listed
and implemented.
1 participant
Summary
[Unreleased]entriesReview fixes
WebCryptoAdapter)docs/GUIDE.mdalready linked as "Guide"*to-for consistency--clear-cacheand--no-persistent-cacheseek flags that were dropped in the rewriteTest plan
npm run lint— zero errors/warningsnpm run test:local— 257 files, 4668 tests passing*list markers remain (0 occurrences)Summary by CodeRabbit