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
9 changes: 9 additions & 0 deletions docs/build/api/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"label": "API",
"position": 3,
"link": {
"type": "generated-index"
},
"collapsible": false,
"collapsed": false
}
10 changes: 10 additions & 0 deletions docs/build/api/contracts/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"label": "Contracts",
"position": 1,
"link": {
"type": "doc",
"id": "build/api/contracts/index"
},
"collapsible": false,
"collapsed": false
}
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: contractsSidebar
displayed_sidebar: buildSidebar
---

# 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: contractsSidebar
displayed_sidebar: buildSidebar
---

# 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: contractsSidebar
displayed_sidebar: buildSidebar
---

# 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: contractsSidebar
displayed_sidebar: buildSidebar
---

# 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: contractsSidebar
displayed_sidebar: buildSidebar
---

# 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: contractsSidebar
displayed_sidebar: buildSidebar
---

# 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: contractsSidebar
displayed_sidebar: buildSidebar
---

# 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: contractsSidebar
displayed_sidebar: buildSidebar
---

# 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: contractsSidebar
displayed_sidebar: buildSidebar
---

# 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: 7
displayed_sidebar: contractsSidebar
displayed_sidebar: buildSidebar
---

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

# Deployed Addresses
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: contractsSidebar
displayed_sidebar: buildSidebar
---

# 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: contractsSidebar
displayed_sidebar: buildSidebar
---

# 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: contractsSidebar
displayed_sidebar: buildSidebar
---

# 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: contractsSidebar
displayed_sidebar: buildSidebar
---

# 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: contractsSidebar
displayed_sidebar: buildSidebar
---

# 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: contractsSidebar
displayed_sidebar: buildSidebar
---

# 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: contractsSidebar
displayed_sidebar: buildSidebar
---

# 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: contractsSidebar
displayed_sidebar: buildSidebar
---

# Treasury
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"label": "SDK",
"position": 5,
"key": "contracts-sdk",
"link": {
"type": "generated-index"
},
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: contractsSidebar
displayed_sidebar: buildSidebar
---

# SDK — API Reference
Expand Down Expand Up @@ -86,4 +86,4 @@ type ContractAddresses = {

### Current Addresses

See [Deployed Addresses](../operations/addresses.md) for the full list.
See [Deployed Addresses](../index.md) for the full list.
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: contractsSidebar
displayed_sidebar: buildSidebar
---

# 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: contractsSidebar
displayed_sidebar: buildSidebar
---

# SDK — Getting Started
Expand Down
2 changes: 1 addition & 1 deletion docs/build/quick-start/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,7 @@ await app.sendPayment('100000', '0xPartnerAddress'); // Send 0.1 USDC

Congratulations! You've built your first Yellow App. Here's what to explore next:

- **[Advanced Topics](../../learn/advanced/architecture)**: Learn about architecture, multi-party applications, and production deployment
- **[Advanced Topics](../../learn/introduction/architecture-at-a-glance)**: Learn about architecture, multi-party applications, and production deployment
- **[API Reference](../../api-reference)**: Explore all available SDK methods and options

## Need Help?
Expand Down
Loading