YNU-864: Learn introduction rewrite (v1 mental model)#152
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
nksazonov
left a comment
There was a problem hiding this comment.
Good job! The terminology migration (Clearnode to Nitronode, VirtualApp/Adjudicator to ChannelHub, lifecycle states, fund flow diagrams) is thorough and internally consistent across all five files. The issues below are mostly authoring artifacts (internal PR numbers, maintainer notes that landed in user copy) and one slightly imprecise diagram label.
nksazonov
left a comment
There was a problem hiding this comment.
Every comment addressed cleanly and promptly — thank you @ihsraham! The v1 mental model lands clearly now: correct terminology throughout, no author-facing notes leaking into user copy, the lifecycle diagram is accurate with the closing state included, and WAD is gone in favour of plain language. This is ready to land. Great work on the rewrite.
- Rewrite the most-read Learn introduction pages around the v1 ChannelHub, Nitronode, channel-state, and ledger model. - Replace stale Custody/Adjudicator/VirtualApp framing with the protocol-backed home-ledger, escrow, commit/release, and CHALLENGED lifecycle terminology. - Replace hardcoded legacy contract address tables with runtime discovery through getConfig/getAssets. Resolves: F-010, F-011, F-012, F-036, F-037.
2c41788 to
a41b696
Compare
Summary
Rewrites the most-read Learn introduction pages around the native v1 model: ChannelHub, Nitronode, signed channel states, home/non-home ledgers, escrow, commit/release app-session funding, and the
void/open/challenged/closedlifecycle.What changed
what-yellow-solvesto teach state channels with v1 channel-state and ChannelHub enforcement terminology.architecture-at-a-glancearound application, SDK/v1 RPC, Nitronode, and ChannelHub surfaces, including theCHALLENGEDlifecycle state.client.getConfig()/node.v1.get_configandclient.getAssets()/node.v1.get_assets.Source of truth
Architectural claims are sourced from
nl/docs/protocol/*.md, the existingyellow-docs/docs/nitrolite/protocol/*.mdxpages,nl/contracts/src/ChannelHub.sol,nl/contracts/deployments/,nl/MIGRATION-NITRONODE.md,nl/docs/api.yaml, and the native TypeScript SDKgetConfig/getAssetsimplementations.Resolves: F-010, F-011, F-012, F-036, F-037.
Validation
DISPUTE, and stale Node custody language.ChannelHub,Nitronode,CHALLENGED,getConfig,get_config, andgithub.com/layer-3/nitrolitechecks pass.npm run buildsucceeds with the same pre-existing Docusaurus deprecation, 0.5.x, and Clearnet broken-link/anchor warnings only./nitrolite/learn/introduction/architecture-at-a-glanceserves successfully from the built site.