Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@ npm-debug.log*
yarn-debug.log*
yarn-error.log*
.vercel
.gstack/
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,23 @@ GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

## Site Architecture

This site hosts two product docs as separate sub-sites under one Docusaurus instance:

- **`/nitrolite/*`** — State channel SDK docs (versioned 1.x / 0.5.x)
- **`/clearnet/*`** — Decentralized clearing protocol docs (unversioned)
- **`/`** — Portal landing page linking to both sub-sites

Source layout:

- `docs/nitrolite/` — Nitrolite content (managed by the preset's docs plugin)
- `docs/clearnet/` — Clearnet content (managed by a second `@docusaurus/plugin-content-docs` instance, id: `clearnet`)
- `sidebars-nitrolite.ts` / `sidebars-clearnet.ts` — sidebar configs per sub-site
- `src/theme/Navbar/Content/` — swizzled component that filters top-navbar items by current path (via `customProps.showOn`)

### Known Limitations

- **Search**: lunr-search uses a single index across both sub-sites. A query from `/nitrolite/...` may surface Clearnet results and vice versa. To scope search per sub-site, replace lunr-search with Algolia (separate indices) or a custom search component.
- **Versioned docs links**: `versioned_docs/version-0.5.x/` is a historical snapshot and still contains `/docs/...` links from when the site lived under that path. Those links break under the new `/nitrolite/0.5.x/...` routing. Either rewrite versioned content links or accept them as archived.
9 changes: 0 additions & 9 deletions docs/build/api/_category_.json

This file was deleted.

File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"position": 1,
"link": {
"type": "doc",
"id": "build/api/contracts/index"
"id": "learn/contracts/index"
},
"collapsible": false,
"collapsed": false
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "AppRegistry"
description: "App builder registry with slashing."
sidebar_position: 4
displayed_sidebar: buildSidebar
displayed_sidebar: clearnetSidebar
---

# AppRegistry
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Faucet"
description: "Testnet token faucet."
sidebar_position: 7
displayed_sidebar: buildSidebar
displayed_sidebar: clearnetSidebar
---

# Faucet
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "ILock"
description: "Lock/unlock/withdraw interface."
sidebar_position: 1
displayed_sidebar: buildSidebar
displayed_sidebar: clearnetSidebar
---

# ILock
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "ISlash"
description: "Slashing interface."
sidebar_position: 2
displayed_sidebar: buildSidebar
displayed_sidebar: clearnetSidebar
---

# ISlash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Locker"
description: "Abstract lock/unlock/withdraw state machine."
sidebar_position: 2
displayed_sidebar: buildSidebar
displayed_sidebar: clearnetSidebar
---

# Locker
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "NodeRegistry"
description: "Node operator registry with voting power."
sidebar_position: 3
displayed_sidebar: buildSidebar
displayed_sidebar: clearnetSidebar
---

# NodeRegistry
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Treasury"
description: "Secure vault for Foundation assets."
sidebar_position: 6
displayed_sidebar: buildSidebar
displayed_sidebar: clearnetSidebar
---

# Treasury
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "YellowGovernor"
description: "OpenZeppelin Governor for protocol parameters."
sidebar_position: 5
displayed_sidebar: buildSidebar
displayed_sidebar: clearnetSidebar
---

# YellowGovernor
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "YellowToken"
description: "ERC-20 token with fixed 10B supply."
sidebar_position: 1
displayed_sidebar: buildSidebar
displayed_sidebar: clearnetSidebar
---

# YellowToken
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "FAQ"
description: "Frequently asked questions about Yellow Network smart contracts."
sidebar_position: 2
displayed_sidebar: buildSidebar
displayed_sidebar: clearnetSidebar
---

# Frequently Asked Questions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Deployed Addresses"
description: "Mainnet and testnet contract addresses for Yellow Network."
sidebar_position: 1
displayed_sidebar: buildSidebar
displayed_sidebar: clearnetSidebar
---


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Deployment"
description: "Deploying contracts and configuration."
sidebar_position: 1
displayed_sidebar: buildSidebar
displayed_sidebar: clearnetSidebar
---

# Deployment
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Events"
description: "Contract events for real-time subscriptions."
sidebar_position: 2
displayed_sidebar: buildSidebar
displayed_sidebar: clearnetSidebar
---

# Events
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "UI Specification"
description: "Frontend implementation guide."
sidebar_position: 3
displayed_sidebar: buildSidebar
displayed_sidebar: clearnetSidebar
---

# UI Specification
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Governance"
description: "On-chain parameter administration via YellowGovernor."
sidebar_position: 2
displayed_sidebar: buildSidebar
displayed_sidebar: clearnetSidebar
---

# Protocol Parameter Administration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Protocol Overview"
description: "Architecture, contracts, and how they fit together."
sidebar_position: 1
displayed_sidebar: buildSidebar
displayed_sidebar: clearnetSidebar
---

# Protocol Overview
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Slashing"
description: "Adjudicator slashing and cooldown mechanism."
sidebar_position: 4
displayed_sidebar: buildSidebar
displayed_sidebar: clearnetSidebar
---

# Slashing
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Collateral & Staking"
description: "Lock/unlock state machine for NodeRegistry and AppRegistry."
sidebar_position: 3
displayed_sidebar: buildSidebar
displayed_sidebar: clearnetSidebar
---

# Collateral
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Treasury"
description: "Foundation asset management."
sidebar_position: 5
displayed_sidebar: buildSidebar
displayed_sidebar: clearnetSidebar
---

# Treasury
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "SDK API Reference"
description: "All exports: ABIs, addresses, and types."
sidebar_position: 2
displayed_sidebar: buildSidebar
displayed_sidebar: clearnetSidebar
---

# SDK — API Reference
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Examples"
description: "Code samples for viem, ethers.js, and wagmi."
sidebar_position: 3
displayed_sidebar: buildSidebar
displayed_sidebar: clearnetSidebar
---

# SDK — Examples
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Getting Started"
description: "Install, import, and use the contracts SDK."
sidebar_position: 1
displayed_sidebar: buildSidebar
displayed_sidebar: clearnetSidebar
---

# SDK — Getting Started
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -336,5 +336,5 @@ Valid combinations:

Now that you understand the vocabulary, continue to:

- **[State Channels vs L1/L2](/docs/learn/core-concepts/state-channels-vs-l1-l2)** — Deep comparison with other scaling solutions
- **[Challenge Response & Disputes](/docs/learn/core-concepts/challenge-response)** — On-chain dispute resolution
- **[State Channels vs L1/L2](/nitrolite/learn/core-concepts/state-channels-vs-l1-l2)** — Deep comparison with other scaling solutions
- **[Challenge Response & Disputes](/nitrolite/learn/core-concepts/challenge-response)** — On-chain dispute resolution
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ Your environment is ready! Continue to:

- **[Key Terms & Mental Models](./key-terms.mdx)** — Understand the core concepts
- **[Quickstart](./quickstart.mdx)** — Build your first Yellow App
- **[State Channels vs L1/L2](/docs/learn/core-concepts/state-channels-vs-l1-l2)** — Deep dive into state channels
- **[State Channels vs L1/L2](/nitrolite/learn/core-concepts/state-channels-vs-l1-l2)** — Deep dive into state channels

---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 2
sidebar_position: 1
sidebar_label: Quick Start
title: Quick Start
description: Build your first Yellow App in 5 minutes - a complete beginner's guide
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "SDK",
"position": 2,
"position": 3,
"collapsed": false,
"collapsible": false
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Go SDK",
"position": 4,
"position": 6,
"collapsed": false,
"collapsible": false
}
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -585,5 +585,5 @@ console.log(`Current weight: ${signatureWeight}, Required: ${quorum}`);

## Further Reading

- [Protocol](/docs/protocol/introduction) — Protocol specification and architecture
- [SDK Reference](/docs/build/sdk) — Complete SDK documentation
- [Protocol Reference](/nitrolite/protocol/protocol-reference) — Protocol specification and architecture
- [SDK Reference](/nitrolite/build/sdk) — Complete SDK documentation
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "TypeScript Compat SDK",
"position": 3,
"position": 5,
"collapsed": false,
"collapsible": false
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "TypeScript SDK",
"position": 2,
"position": 4,
"collapsed": false,
"collapsible": false
}
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -152,4 +152,4 @@ You can **always** recover your funds according to the latest mutually signed st

## Deep Dive

For technical implementation details, see the [Protocol](/docs/protocol/introduction) section.
For technical implementation details, see the [Protocol Reference](/nitrolite/protocol/protocol-reference) section.
Original file line number Diff line number Diff line change
Expand Up @@ -140,4 +140,4 @@ State channels shine when you have identified participants who will interact fre

For technical details on channel implementation:

- **[Architecture](/docs/protocol/architecture.mdx)** — System design and fund flows
- **[Protocol Reference](/nitrolite/protocol/protocol-reference)** — System design and fund flows
4 changes: 2 additions & 2 deletions docs/learn/index.mdx → docs/nitrolite/learn/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ Detailed v1 protocol flow documentation for deposits, withdrawals, transfers, an

After completing the Learn section, continue to:

- **[Build](/docs/build/quick-start)** — Implement complete Yellow Applications
- **[Protocol Reference](/docs/protocol/introduction)** — Authoritative protocol specification
- **[Build](/nitrolite/build/quick-start)** — Implement complete Yellow Applications
- **[Protocol Reference](/nitrolite/protocol/protocol-reference)** — Authoritative protocol specification

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ stateDiagram-v2
```

:::info Legacy Flow
The diagram above shows the recommended flow where both participants sign the initial state, creating the channel directly in ACTIVE status. A legacy flow also exists where only the creator signs initially (status becomes INITIAL), and other participants call `join()` separately. See the [Protocol](/docs/protocol/introduction) section for details.
The diagram above shows the recommended flow where both participants sign the initial state, creating the channel directly in ACTIVE status. A legacy flow also exists where only the creator signs initially (status becomes INITIAL), and other participants call `join()` separately. See the [Protocol Reference](/nitrolite/protocol/protocol-reference) section for details.
:::

### Typical Flow
Expand Down Expand Up @@ -256,6 +256,6 @@ At every stage, funds remain cryptographically secured. You can always recover y

Ready to start building? Continue to:

- **[Quickstart](/docs/build/getting-started/quickstart)** — Create your first channel in minutes
- **[Prerequisites](/docs/build/getting-started/prerequisites)** — Set up your development environment
- **[Quickstart](/nitrolite/build/getting-started/quickstart)** — Create your first channel in minutes
- **[Prerequisites](/nitrolite/build/getting-started/prerequisites)** — Set up your development environment
- **[Core Concepts](../core-concepts/state-channels-vs-l1-l2.mdx)** — Deep dive into state channels
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,6 @@ const productionAllocations = [

## See Also

- [Quick Start Guide](/docs/build/quick-start) — Get started building with Yellow SDK
- [Multi-Party App Sessions](/docs/build/sdk/multi-party-app-sessions) — Create multi-party application sessions
- [API Reference](/docs/api-reference) — Complete SDK documentation
- [Quick Start Guide](/nitrolite/build/quick-start) — Get started building with Yellow SDK
- [Multi-Party App Sessions](/nitrolite/build/sdk/multi-party-app-sessions) — Create multi-party application sessions
- [API Reference](/nitrolite/api-reference) — Complete SDK documentation
Original file line number Diff line number Diff line change
Expand Up @@ -146,4 +146,4 @@ If a Clearnode becomes unresponsive or malicious, you can submit your latest sig
Now that you understand what Yellow solves, continue to:

- **[Architecture at a Glance](./architecture-at-a-glance.mdx)** — See how the protocol layers work together
- **[Quickstart](/docs/build/getting-started/quickstart)** — Create your first state channel in minutes
- **[Quickstart](/nitrolite/build/getting-started/quickstart)** — Create your first state channel in minutes
File renamed without changes.
Loading