YNU-864: Learn introduction rewrite (v1 mental model)#152
Open
ihsraham wants to merge 1 commit intodocs/reorg-for-v1from
Open
YNU-864: Learn introduction rewrite (v1 mental model)#152ihsraham wants to merge 1 commit intodocs/reorg-for-v1from
ihsraham wants to merge 1 commit intodocs/reorg-for-v1from
Conversation
- 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.
|
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.