Skip to content

docs: add dev diagrams#593

Closed
0xstepit wants to merge 6 commits into
mainfrom
stepit/docs
Closed

docs: add dev diagrams#593
0xstepit wants to merge 6 commits into
mainfrom
stepit/docs

Conversation

@0xstepit

@0xstepit 0xstepit commented Sep 25, 2025

Copy link
Copy Markdown
Contributor

This PR is the first of a series of PRs to improve the technical documentation around the Noble Core.

@coderabbitai

coderabbitai Bot commented Sep 25, 2025

Copy link
Copy Markdown

Walkthrough

Adds four new developer documentation pages under docs/dev: dependencies.md, interoperability.md, issuance.md, and security.md. Each file documents Noble's architecture with descriptive text and Mermaid diagrams; no code, API, or exported-entity changes.

Changes

Cohort / File(s) Change Summary
Dev Docs — Dependencies
docs/dev/dependencies.md
Added module dependency graph and Mermaid flowchart describing Noble modules and their interconnections (Cosmos SDK, Noble, External). Documentation only.
Dev Docs — Interoperability
docs/dev/interoperability.md
Added interoperability architecture doc covering Bridge Protocols, Orbiter abstraction, dual access patterns, hook-based workflow, and Mermaid diagrams. Documentation only.
Dev Docs — Issuance
docs/dev/issuance.md
Added token issuance documentation outlining Issuers → Tokens → Modules → Bank relationships with a Mermaid diagram. Documentation only.
Dev Docs — Security
docs/dev/security.md
Added security architecture doc with two Mermaid diagrams (generic security layering and token issuance security). Documentation only.

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)
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

  • johnletey
  • boojamya

Poem

I nibble docs beneath the moon,
Mapping modules, hook and rune.
Bridges hum and diagrams hop—
Tokens, flows, the details drop.
🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title succinctly conveys that new developer documentation diagrams are being added, directly matching the changeset’s focus on introducing dev diagrams in the docs.
Description Check ✅ Passed The description states that this PR is the first in a series to improve technical documentation for the Noble Core, which aligns with the introduction of new documentation files and diagrams in this changeset.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch stepit/docs

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 94781de and ed66be9.

📒 Files selected for processing (3)
  • docs/dev/interoperability.md (1 hunks)
  • docs/dev/issuance.md (1 hunks)
  • docs/dev/security.md (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • docs/dev/security.md
  • docs/dev/issuance.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/dev/interoperability.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: prepare
  • GitHub Check: build
  • GitHub Check: build-and-push-image

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.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@0xstepit
0xstepit marked this pull request as ready for review September 25, 2025 16:22
@0xstepit
0xstepit requested a review from a team as a code owner September 25, 2025 16:22
@0xstepit 0xstepit self-assigned this Sep 25, 2025

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

🧹 Nitpick comments (1)
docs/dev/interoperability.md (1)

37-40: Nest the subgraphs directly instead of referencing them by name.
Listing Orbiter and Bridges inside the Noble subgraph (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

📥 Commits

Reviewing files that changed from the base of the PR and between 434f15e and 6331e1e.

📒 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

Comment thread docs/dev/dependencies.md
Comment thread docs/dev/interoperability.md Outdated
Comment thread docs/dev/issuance.md Outdated
Comment thread docs/dev/security.md
Comment thread docs/dev/security.md
MalteHerrmann
MalteHerrmann previously approved these changes Sep 26, 2025

@MalteHerrmann MalteHerrmann left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome work as always @0xstepit 🙌
I left some suggestions but these diagrams are super helpful 💪

Comment thread docs/dev/interoperability.md
Comment thread docs/dev/interoperability.md
Comment thread docs/dev/issuance.md Outdated
Comment thread docs/dev/security.md
Comment thread docs/dev/security.md

@MalteHerrmann MalteHerrmann left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

awesome work as usual 🚀

@johnletey johnletey closed this Apr 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants