docs: add dev diagrams#593
Conversation
WalkthroughAdds four new developer documentation pages under docs/dev: Changes
Sequence Diagram(s)sequenceDiagram
participant Sender
participant Orbiter
participant Bridge
participant Recipient
rect rgb(220,235,255)
Note over Sender,Orbiter: Dual access option: via Orbiter or direct bridge
end
Sender->>Orbiter: Initiate transfer + hooks (Before Transfer)
Orbiter->>Bridge: Route / integrate with selected bridge
Bridge->>Recipient: Cross-chain transfer
Recipient-->>Orbiter: Bridge callback / confirmation
Orbiter->>Recipient: After Transfer Hook (finalize / composability)
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (3)
✅ Files skipped from review due to trivial changes (2)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ 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)
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. 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.
Actionable comments posted: 5
🧹 Nitpick comments (1)
docs/dev/interoperability.md (1)
37-40: Nest the subgraphs directly instead of referencing them by name.
ListingOrbiterandBridgesinside theNoblesubgraph (after defining them separately) causes Mermaid to spawn duplicate nodes rather than embedding the existing subgraphs. Declare the nested subgraphs inline to keep the hierarchy intact.- subgraph Noble - Orbiter - Bridges - end + subgraph Noble + subgraph NobleOrbiter + f + a + end + subgraph NobleBridges + wormhole + cctp + ibc + hyperlane + end + end(Adjust the subgraph labels as needed, but keep the nested declarations inline.)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
docs/dev/dependencies.md(1 hunks)docs/dev/interoperability.md(1 hunks)docs/dev/issuance.md(1 hunks)docs/dev/security.md(1 hunks)
⏰ 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: prepare
- GitHub Check: build
- GitHub Check: build-and-push-image
MalteHerrmann
left a comment
There was a problem hiding this comment.
Awesome work as always @0xstepit 🙌
I left some suggestions but these diagrams are super helpful 💪
MalteHerrmann
left a comment
There was a problem hiding this comment.
awesome work as usual 🚀
This PR is the first of a series of PRs to improve the technical documentation around the Noble Core.