-
Notifications
You must be signed in to change notification settings - Fork 53
fix: architecture doccs syntax #493
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
WalkthroughRefactors documentation: Mermaid diagram labels in the architecture overview were changed to quoted strings, node labels gain HTML-like line breaks, and edge labels were clarified; the "What's Next" TanStack DB section wording and cross-cutting note were updated; the knowledge-base link and timestamp were updated. No behavior or control flow changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (2 warnings)
✅ Passed checks (1 passed)
✨ Finishing touches🧪 Generate unit tests
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 |
d7107ba
to
b302b88
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
etc/architecture/overview.md (1)
47-50
: Avoid quoting Mermaid edge labels.Wrapping edge text in quotes renders the quotes literally in Mermaid. Prefer the pipe syntax so the labels stay clean.
- World -- "events & state" --> ToriiIndexer - CoreProvider -- "invoke / call" --> World - ToriiIndexer -- "queries / subscriptions" --> ToriiWasm - ToriiIndexer -- "gRPC streams" --> GrpcClient + World --|events & state|--> ToriiIndexer + CoreProvider --|invoke / call|--> World + ToriiIndexer --|queries / subscriptions|--> ToriiWasm + ToriiIndexer --|gRPC streams|--> GrpcClient
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
etc/architecture/overview.md
(1 hunks)etc/architecture/whats-next.md
(2 hunks)etc/knowledge-base.md
(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- etc/knowledge-base.md
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-09-23T14:02:06.709Z
Learnt from: CR
PR: dojoengine/dojo.js#0
File: AGENTS.md:0-0
Timestamp: 2025-09-23T14:02:06.709Z
Learning: Prefer small, stacked changes using jj new and jj describe
Applied to files:
etc/architecture/whats-next.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: build-examples
- GitHub Check: build-packages
- GitHub Check: build
🔇 Additional comments (3)
etc/architecture/whats-next.md (2)
32-39
: Terminology edit improves clarity.Switching the TanStack section title and generalizing the manifest reference reads cleaner and better matches current naming.
61-61
: Appreciate the incremental-delivery reminder.The cross-cutting note reinforces our stacked
jj
preference and keeps the roadmap actionable. Based on learningsetc/architecture/overview.md (1)
18-32
: Mermaid subgraph/node updates render well.Quoting the subgraph titles and using
<br/>
in node labels improves the diagram’s readability without altering structure.
Closes #
Introduced changes
Checklist
Summary by CodeRabbit