Skip to content

docs: update diagrams docs#1342

Merged
rackstar merged 4 commits intorelease-candidatefrom
docs/smart-contract-docs-diagrams-update
Mar 17, 2026
Merged

docs: update diagrams docs#1342
rackstar merged 4 commits intorelease-candidatefrom
docs/smart-contract-docs-diagrams-update

Conversation

@rackstar
Copy link
Copy Markdown
Contributor

@rackstar rackstar commented Mar 13, 2025

Description

  • improve readability of diagram docs
  • add claims-assessments diagram docs
  • add governor-registry diagram docs

Testing

N/A but I did proof read

Checklist

  • Performed a self-review of my own code
  • Made corresponding changes to the documentation

Summary by CodeRabbit

Documentation

  • Documentation
    • Added new documentation for claims assessments and governance/registry contract flows with detailed diagrams and technical notes.
    • Reorganized governance documentation; removed standalone governance & membership documentation file.
    • Improved formatting and visual clarity across contract and user-flow diagrams with bolded step identifiers and code-style references.

@rackstar rackstar requested review from MilGard91 and duxxud March 13, 2025 18:43
@rackstar rackstar self-assigned this Mar 13, 2025
@rackstar rackstar force-pushed the docs/smart-contract-docs-diagrams-update branch from 07ef149 to 68cc5fc Compare March 14, 2025 06:35
MilGard91
MilGard91 previously approved these changes Mar 14, 2025
@rackstar
Copy link
Copy Markdown
Contributor Author

will rebase and merge after the audit so avoid causing conflicts with the current PRs we have

@shark0der shark0der marked this pull request as draft August 18, 2025 17:23
@shark0der
Copy link
Copy Markdown
Contributor

shark0der commented Aug 18, 2025

on hold to be re-reviewed and merged after breaking/v3

@shark0der shark0der changed the base branch from release-candidate to breaking/v3 August 18, 2025 17:24
Base automatically changed from breaking/v3 to audit/governance-and-assessments-august-2025 September 4, 2025 11:28
@shark0der shark0der force-pushed the audit/governance-and-assessments-august-2025 branch from 64d1ffd to 5d445ff Compare September 4, 2025 12:29
Base automatically changed from audit/governance-and-assessments-august-2025 to release-candidate October 30, 2025 12:29
@shark0der shark0der dismissed MilGard91’s stale review October 30, 2025 12:29

The base branch was changed.

@rackstar rackstar force-pushed the docs/smart-contract-docs-diagrams-update branch 2 times, most recently from 082e247 to 67d4b95 Compare November 7, 2025 14:40
@rackstar rackstar marked this pull request as ready for review November 7, 2025 14:40
@rackstar rackstar force-pushed the docs/smart-contract-docs-diagrams-update branch from 67d4b95 to 9c71abe Compare November 14, 2025 14:32
@rackstar rackstar force-pushed the docs/smart-contract-docs-diagrams-update branch 2 times, most recently from 618dcd6 to 9ce552e Compare December 3, 2025 07:30
@rackstar rackstar force-pushed the docs/smart-contract-docs-diagrams-update branch from 9ce552e to 1d69e94 Compare March 16, 2026 15:03
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 16, 2026

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e4b22d29-4c61-4afc-9884-848c0a3f18a8

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

This pull request updates documentation diagrams across the docs/diagrams/ directory with consistent formatting changes (bolding step labels and adding inline code styling), reorganizes two documentation files with updated content, and refreshes diagram visual presentation without altering underlying flows or workflows.

Changes

Cohort / File(s) Summary
Documentation File Consolidation
docs/diagrams/contracts/claims-assessment.md, docs/diagrams/contracts/claims-assessments.md
Removed outdated claims-assessment.md documentation and added replacement claims-assessments.md with updated Mermaid diagrams for submit claim, assessment voting, claim payout, and deposit retrieval flows, plus technical notes on timing and mechanics.
Documentation File Reorganization
docs/diagrams/contracts/governance-membership.md, docs/diagrams/contracts/governor-registry.md
Removed governance-membership.md and added replacement governor-registry.md with updated documentation on Member and Advisory Board proposal flows, voting processes, execution, outcomes, and registry dependencies.
Diagram Formatting Updates
docs/diagrams/contracts/capital.md, docs/diagrams/contracts/cover.md, docs/diagrams/contracts/staking.md, docs/diagrams/contracts/token.md, docs/diagrams/nexus-mutual.md, docs/diagrams/user-flows/cover-buyer.md, docs/diagrams/user-flows/staker.md, docs/diagrams/user-flows/staking-manager.md
Applied consistent cosmetic formatting across all diagram files: bolded step identifiers (e.g., **(1a)**), added inline code formatting for entity and contract references, and updated Mermaid diagram labels. No changes to flow logic or control flow.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 1 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'docs: update diagrams docs' is vague and generic. While it relates to the changeset (documentation diagrams), it lacks specificity about the nature of the updates (formatting improvements, file additions/removals) and doesn't convey meaningful information about what was actually changed. Consider a more descriptive title that captures the main changes, such as 'docs: refactor diagram documentation with formatting improvements and restructuring' or 'docs: standardize diagram formatting and reorganize governance/claims documentation'.
✅ Passed checks (1 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/smart-contract-docs-diagrams-update
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/smart-contract-docs-diagrams-update
📝 Coding Plan
  • Generate coding plan for human review comments

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

Tip

CodeRabbit can suggest fixes for GitHub Check annotations.

Configure the reviews.tools.github-checks setting to adjust the time to wait for GitHub Checks to complete.

MilGard91
MilGard91 previously approved these changes Mar 16, 2026
Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 5

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/diagrams/contracts/cover.md`:
- Around line 68-71: The steps labeled "(1b) `Cover` validates product with
CoverProducts", "(1c) `Cover` mints NFT representing cover" and "(1d) `Cover`
processes payment via Pool" are currently indented as children of the "- Cover
asset" bullet; outdent them to the same indentation level as the other top-level
bullets so they render as sequential top-level steps (remove the leading spaces
before those lines so they align with the surrounding top-level list).

In `@docs/diagrams/contracts/governor-registry.md`:
- Line 90: Replace the malformed step marker string **(`1b`)** with the
correctly formatted **(1b)** in the governor-registry diagram text; locate the
occurrence of the literal marker **(`1b`)** (the step label before "Governor
validates AB membership via Registry") and update it to **(1b)** so it matches
the document's step formatting.

In `@docs/diagrams/nexus-mutual.md`:
- Around line 59-67: The diagram references undefined Mermaid nodes IndClaims,
Assess, and Assessor (used with actions like submitClaim(), startAssessment(),
castVotes()), which causes implicit node rendering and breaks styling; add
explicit node declarations for these identifiers near the top of the diagram
(e.g., declare shapes/labels for IndClaims, Assess, and Assessor) so they are
defined before being referenced, ensuring consistent grouping and styling across
the flow.

In `@docs/diagrams/user-flows/cover-buyer.md`:
- Line 82: Fix the malformed Markdown token on the quote step by replacing the
broken string "`Cover`outer API**" with a correctly formatted phrase such as
"`Cover outer API`" or "**Cover outer API**" so the backticks and bold markers
are used consistently; update the offending text in the document (the line
containing the token) to a single well-formed Markdown token like `Cover outer
API` or **Cover outer API** to ensure it renders correctly.
- Line 24: The Mermaid edges reference undeclared nodes—declare the missing
nodes MemberRoles, StakingPool, and CoverNFT in their respective diagrams so
edges render correctly; add explicit node definitions (e.g., MemberRoles[(Member
Roles)], StakingPool[(Staking Pool)] and CoverNFT[(Cover NFT)] or equivalent
labels) in the user-flow diagrams where those edges are used (the flow
containing the edge "Cover -->|\"**(2b)** onlyMember check\"| MemberRoles", the
flow with StakingPool at line 28, and the Claims Flow that references CoverNFT)
ensuring labels/grouping match the surrounding diagram style.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 258b03ae-8201-4b6f-85cd-45716cd746de

📥 Commits

Reviewing files that changed from the base of the PR and between d6370e4 and 1d69e94.

📒 Files selected for processing (12)
  • docs/diagrams/contracts/capital.md
  • docs/diagrams/contracts/claims-assessment.md
  • docs/diagrams/contracts/claims-assessments.md
  • docs/diagrams/contracts/cover.md
  • docs/diagrams/contracts/governance-membership.md
  • docs/diagrams/contracts/governor-registry.md
  • docs/diagrams/contracts/staking.md
  • docs/diagrams/contracts/token.md
  • docs/diagrams/nexus-mutual.md
  • docs/diagrams/user-flows/cover-buyer.md
  • docs/diagrams/user-flows/staker.md
  • docs/diagrams/user-flows/staking-manager.md
💤 Files with no reviewable changes (2)
  • docs/diagrams/contracts/claims-assessment.md
  • docs/diagrams/contracts/governance-membership.md

@rackstar
Copy link
Copy Markdown
Contributor Author

all formatting issues fixed. doubled check the rendered markdown and can confirm it looks ok

@rackstar rackstar merged commit ad21204 into release-candidate Mar 17, 2026
7 checks passed
@rackstar rackstar deleted the docs/smart-contract-docs-diagrams-update branch March 17, 2026 08:33
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