Skip to content

YNU-864: Learn introduction rewrite (v1 mental model)#152

Merged
ihsraham merged 2 commits into
docs/reorg-for-v1from
feat/ynu-864-learn-introduction-rewrite
May 15, 2026
Merged

YNU-864: Learn introduction rewrite (v1 mental model)#152
ihsraham merged 2 commits into
docs/reorg-for-v1from
feat/ynu-864-learn-introduction-rewrite

Conversation

@ihsraham
Copy link
Copy Markdown
Collaborator

@ihsraham ihsraham commented May 8, 2026

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/closed lifecycle.

What changed

  • Updated the Learn index to describe Nitronode, split YELLOW-token utility from free/open-source SDK tooling, and point 0.5.3 readers at the planned migration page.
  • Rewrote what-yellow-solves to teach state channels with v1 channel-state and ChannelHub enforcement terminology.
  • Rebuilt architecture-at-a-glance around application, SDK/v1 RPC, Nitronode, and ChannelHub surfaces, including the CHALLENGED lifecycle state.
  • Replaced stale supported-chain contract address tables with runtime discovery through client.getConfig() / node.v1.get_config and client.getAssets() / node.v1.get_assets.
  • Updated the Petal Diagram page so app-session funds are described as commit/release extension states, not Node-wallet custody.

Source of truth

Architectural claims are sourced from nl/docs/protocol/*.md, the existing yellow-docs/docs/nitrolite/protocol/*.mdx pages, nl/contracts/src/ChannelHub.sol, nl/contracts/deployments/, nl/MIGRATION-NITRONODE.md, nl/docs/api.yaml, and the native TypeScript SDK getConfig / getAssets implementations.

Resolves: F-010, F-011, F-012, F-036, F-037.

Validation

  • Vale on the five touched files: 0 findings.
  • PR diff Vale advisory lint: 0 findings.
  • Source verification grep checks pass for removal of Custody/Adjudicator/VirtualApp/Nitro RPC Protocol, legacy hardcoded addresses, DISPUTE, and stale Node custody language.
  • ChannelHub, Nitronode, CHALLENGED, getConfig, get_config, and github.com/layer-3/nitrolite checks pass.
  • Five edited pages total 494 lines, under the reviewability target.
  • npm run build succeeds with the same pre-existing Docusaurus deprecation, 0.5.x, and Clearnet broken-link/anchor warnings only.
  • Local static server smoke check: /nitrolite/learn/introduction/architecture-at-a-glance serves successfully from the built site.

@ihsraham ihsraham requested a review from dpatsora as a code owner May 8, 2026 08:11
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 8, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

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: defaults

Review profile: CHILL

Plan: Pro

Run ID: 323b09cb-91d5-42ee-b687-3f42501865d8

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
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/ynu-864-learn-introduction-rewrite

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.

Comment thread docs/nitrolite/learn/introduction/architecture-at-a-glance.mdx Outdated
Comment thread docs/nitrolite/learn/introduction/architecture-at-a-glance.mdx Outdated
Comment thread docs/nitrolite/learn/introduction/architecture-at-a-glance.mdx Outdated
Comment thread docs/nitrolite/learn/introduction/architecture-at-a-glance.mdx Outdated
Comment thread docs/nitrolite/learn/introduction/architecture-at-a-glance.mdx Outdated
Comment thread docs/nitrolite/learn/introduction/supported-chains.mdx Outdated
Comment thread docs/nitrolite/learn/introduction/supported-chains.mdx Outdated
Comment thread docs/nitrolite/learn/introduction/what-yellow-solves.mdx Outdated
Comment thread docs/nitrolite/learn/introduction/what-yellow-solves.mdx Outdated
Comment thread docs/nitrolite/learn/protocol-flows/architecture.mdx Outdated
Comment thread docs/nitrolite/learn/index.mdx Outdated
Comment thread docs/nitrolite/learn/index.mdx Outdated
Copy link
Copy Markdown
Contributor

@nksazonov nksazonov left a comment

Choose a reason for hiding this comment

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

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.

Comment thread docs/nitrolite/learn/index.mdx Outdated
Comment thread docs/nitrolite/learn/protocol-flows/architecture.mdx Outdated
Comment thread docs/nitrolite/learn/protocol-flows/architecture.mdx Outdated
Comment thread docs/nitrolite/learn/introduction/supported-chains.mdx Outdated
Comment thread docs/nitrolite/learn/introduction/architecture-at-a-glance.mdx Outdated
Copy link
Copy Markdown
Contributor

@nksazonov nksazonov left a comment

Choose a reason for hiding this comment

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

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.

ihsraham added 2 commits May 15, 2026 15:52
- 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.
@ihsraham ihsraham force-pushed the feat/ynu-864-learn-introduction-rewrite branch from 2c41788 to a41b696 Compare May 15, 2026 10:23
@ihsraham ihsraham merged commit 387045f into docs/reorg-for-v1 May 15, 2026
4 checks passed
@ihsraham ihsraham deleted the feat/ynu-864-learn-introduction-rewrite branch May 15, 2026 10:24
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