docs: update diagrams docs#1342
Conversation
07ef149 to
68cc5fc
Compare
|
will rebase and merge after the audit so avoid causing conflicts with the current PRs we have |
|
on hold to be re-reviewed and merged after breaking/v3 |
64d1ffd to
5d445ff
Compare
082e247 to
67d4b95
Compare
67d4b95 to
9c71abe
Compare
618dcd6 to
9ce552e
Compare
9ce552e to
1d69e94
Compare
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThis pull request updates documentation diagrams across the Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 1 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
📝 Coding Plan
Comment Tip CodeRabbit can suggest fixes for GitHub Check annotations.Configure the |
There was a problem hiding this comment.
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
📒 Files selected for processing (12)
docs/diagrams/contracts/capital.mddocs/diagrams/contracts/claims-assessment.mddocs/diagrams/contracts/claims-assessments.mddocs/diagrams/contracts/cover.mddocs/diagrams/contracts/governance-membership.mddocs/diagrams/contracts/governor-registry.mddocs/diagrams/contracts/staking.mddocs/diagrams/contracts/token.mddocs/diagrams/nexus-mutual.mddocs/diagrams/user-flows/cover-buyer.mddocs/diagrams/user-flows/staker.mddocs/diagrams/user-flows/staking-manager.md
💤 Files with no reviewable changes (2)
- docs/diagrams/contracts/claims-assessment.md
- docs/diagrams/contracts/governance-membership.md
|
all formatting issues fixed. doubled check the rendered markdown and can confirm it looks ok |
Description
Testing
N/A but I did proof read
Checklist
Summary by CodeRabbit
Documentation