diff --git a/.gitignore b/.gitignore index b580350..90af70d 100644 --- a/.gitignore +++ b/.gitignore @@ -21,3 +21,4 @@ npm-debug.log* yarn-debug.log* yarn-error.log* .vercel +.gstack/ diff --git a/README.md b/README.md index b28211a..c8a01c0 100644 --- a/README.md +++ b/README.md @@ -39,3 +39,23 @@ GIT_USER= 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. diff --git a/docs/build/api/_category_.json b/docs/build/api/_category_.json deleted file mode 100644 index 69cc463..0000000 --- a/docs/build/api/_category_.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "label": "API", - "position": 3, - "link": { - "type": "generated-index" - }, - "collapsible": false, - "collapsed": false -} diff --git a/docs/protocol/architecture.mdx b/docs/clearnet/learn/architecture.mdx similarity index 100% rename from docs/protocol/architecture.mdx rename to docs/clearnet/learn/architecture.mdx diff --git a/docs/build/api/contracts/_category_.json b/docs/clearnet/learn/contracts/_category_.json similarity index 76% rename from docs/build/api/contracts/_category_.json rename to docs/clearnet/learn/contracts/_category_.json index 7cb0321..510e0b2 100644 --- a/docs/build/api/contracts/_category_.json +++ b/docs/clearnet/learn/contracts/_category_.json @@ -3,7 +3,7 @@ "position": 1, "link": { "type": "doc", - "id": "build/api/contracts/index" + "id": "learn/contracts/index" }, "collapsible": false, "collapsed": false diff --git a/docs/build/api/contracts/api-reference/_category_.json b/docs/clearnet/learn/contracts/api-reference/_category_.json similarity index 100% rename from docs/build/api/contracts/api-reference/_category_.json rename to docs/clearnet/learn/contracts/api-reference/_category_.json diff --git a/docs/build/api/contracts/api-reference/app-registry.md b/docs/clearnet/learn/contracts/api-reference/app-registry.md similarity index 99% rename from docs/build/api/contracts/api-reference/app-registry.md rename to docs/clearnet/learn/contracts/api-reference/app-registry.md index efaaec0..a228e3a 100644 --- a/docs/build/api/contracts/api-reference/app-registry.md +++ b/docs/clearnet/learn/contracts/api-reference/app-registry.md @@ -2,7 +2,7 @@ title: "AppRegistry" description: "App builder registry with slashing." sidebar_position: 4 -displayed_sidebar: buildSidebar +displayed_sidebar: clearnetSidebar --- # AppRegistry diff --git a/docs/build/api/contracts/api-reference/faucet.md b/docs/clearnet/learn/contracts/api-reference/faucet.md similarity index 98% rename from docs/build/api/contracts/api-reference/faucet.md rename to docs/clearnet/learn/contracts/api-reference/faucet.md index 9ee6f99..54670cb 100644 --- a/docs/build/api/contracts/api-reference/faucet.md +++ b/docs/clearnet/learn/contracts/api-reference/faucet.md @@ -2,7 +2,7 @@ title: "Faucet" description: "Testnet token faucet." sidebar_position: 7 -displayed_sidebar: buildSidebar +displayed_sidebar: clearnetSidebar --- # Faucet diff --git a/docs/build/api/contracts/api-reference/interfaces/_category_.json b/docs/clearnet/learn/contracts/api-reference/interfaces/_category_.json similarity index 100% rename from docs/build/api/contracts/api-reference/interfaces/_category_.json rename to docs/clearnet/learn/contracts/api-reference/interfaces/_category_.json diff --git a/docs/build/api/contracts/api-reference/interfaces/ilock.md b/docs/clearnet/learn/contracts/api-reference/interfaces/ilock.md similarity index 99% rename from docs/build/api/contracts/api-reference/interfaces/ilock.md rename to docs/clearnet/learn/contracts/api-reference/interfaces/ilock.md index ae5753e..e59ec79 100644 --- a/docs/build/api/contracts/api-reference/interfaces/ilock.md +++ b/docs/clearnet/learn/contracts/api-reference/interfaces/ilock.md @@ -2,7 +2,7 @@ title: "ILock" description: "Lock/unlock/withdraw interface." sidebar_position: 1 -displayed_sidebar: buildSidebar +displayed_sidebar: clearnetSidebar --- # ILock diff --git a/docs/build/api/contracts/api-reference/interfaces/islash.md b/docs/clearnet/learn/contracts/api-reference/interfaces/islash.md similarity index 98% rename from docs/build/api/contracts/api-reference/interfaces/islash.md rename to docs/clearnet/learn/contracts/api-reference/interfaces/islash.md index 8a71ea8..010a979 100644 --- a/docs/build/api/contracts/api-reference/interfaces/islash.md +++ b/docs/clearnet/learn/contracts/api-reference/interfaces/islash.md @@ -2,7 +2,7 @@ title: "ISlash" description: "Slashing interface." sidebar_position: 2 -displayed_sidebar: buildSidebar +displayed_sidebar: clearnetSidebar --- # ISlash diff --git a/docs/build/api/contracts/api-reference/locker.md b/docs/clearnet/learn/contracts/api-reference/locker.md similarity index 99% rename from docs/build/api/contracts/api-reference/locker.md rename to docs/clearnet/learn/contracts/api-reference/locker.md index 62a9118..0cc21cd 100644 --- a/docs/build/api/contracts/api-reference/locker.md +++ b/docs/clearnet/learn/contracts/api-reference/locker.md @@ -2,7 +2,7 @@ title: "Locker" description: "Abstract lock/unlock/withdraw state machine." sidebar_position: 2 -displayed_sidebar: buildSidebar +displayed_sidebar: clearnetSidebar --- # Locker diff --git a/docs/build/api/contracts/api-reference/node-registry.md b/docs/clearnet/learn/contracts/api-reference/node-registry.md similarity index 97% rename from docs/build/api/contracts/api-reference/node-registry.md rename to docs/clearnet/learn/contracts/api-reference/node-registry.md index 17dfc09..d8b3344 100644 --- a/docs/build/api/contracts/api-reference/node-registry.md +++ b/docs/clearnet/learn/contracts/api-reference/node-registry.md @@ -2,7 +2,7 @@ title: "NodeRegistry" description: "Node operator registry with voting power." sidebar_position: 3 -displayed_sidebar: buildSidebar +displayed_sidebar: clearnetSidebar --- # NodeRegistry diff --git a/docs/build/api/contracts/api-reference/treasury.md b/docs/clearnet/learn/contracts/api-reference/treasury.md similarity index 97% rename from docs/build/api/contracts/api-reference/treasury.md rename to docs/clearnet/learn/contracts/api-reference/treasury.md index 96df3c6..59eedeb 100644 --- a/docs/build/api/contracts/api-reference/treasury.md +++ b/docs/clearnet/learn/contracts/api-reference/treasury.md @@ -2,7 +2,7 @@ title: "Treasury" description: "Secure vault for Foundation assets." sidebar_position: 6 -displayed_sidebar: buildSidebar +displayed_sidebar: clearnetSidebar --- # Treasury diff --git a/docs/build/api/contracts/api-reference/yellow-governor.md b/docs/clearnet/learn/contracts/api-reference/yellow-governor.md similarity index 99% rename from docs/build/api/contracts/api-reference/yellow-governor.md rename to docs/clearnet/learn/contracts/api-reference/yellow-governor.md index b2604d1..2484416 100644 --- a/docs/build/api/contracts/api-reference/yellow-governor.md +++ b/docs/clearnet/learn/contracts/api-reference/yellow-governor.md @@ -2,7 +2,7 @@ title: "YellowGovernor" description: "OpenZeppelin Governor for protocol parameters." sidebar_position: 5 -displayed_sidebar: buildSidebar +displayed_sidebar: clearnetSidebar --- # YellowGovernor diff --git a/docs/build/api/contracts/api-reference/yellow-token.md b/docs/clearnet/learn/contracts/api-reference/yellow-token.md similarity index 95% rename from docs/build/api/contracts/api-reference/yellow-token.md rename to docs/clearnet/learn/contracts/api-reference/yellow-token.md index a00b819..2470286 100644 --- a/docs/build/api/contracts/api-reference/yellow-token.md +++ b/docs/clearnet/learn/contracts/api-reference/yellow-token.md @@ -2,7 +2,7 @@ title: "YellowToken" description: "ERC-20 token with fixed 10B supply." sidebar_position: 1 -displayed_sidebar: buildSidebar +displayed_sidebar: clearnetSidebar --- # YellowToken diff --git a/docs/build/api/contracts/faq.md b/docs/clearnet/learn/contracts/faq.md similarity index 99% rename from docs/build/api/contracts/faq.md rename to docs/clearnet/learn/contracts/faq.md index 1e5c034..6797c3b 100644 --- a/docs/build/api/contracts/faq.md +++ b/docs/clearnet/learn/contracts/faq.md @@ -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 diff --git a/docs/build/api/contracts/index.md b/docs/clearnet/learn/contracts/index.md similarity index 97% rename from docs/build/api/contracts/index.md rename to docs/clearnet/learn/contracts/index.md index ec00923..7370a5a 100644 --- a/docs/build/api/contracts/index.md +++ b/docs/clearnet/learn/contracts/index.md @@ -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 --- diff --git a/docs/build/api/contracts/integration/_category_.json b/docs/clearnet/learn/contracts/integration/_category_.json similarity index 100% rename from docs/build/api/contracts/integration/_category_.json rename to docs/clearnet/learn/contracts/integration/_category_.json diff --git a/docs/build/api/contracts/integration/deployment.md b/docs/clearnet/learn/contracts/integration/deployment.md similarity index 98% rename from docs/build/api/contracts/integration/deployment.md rename to docs/clearnet/learn/contracts/integration/deployment.md index eb32485..7ec7c53 100644 --- a/docs/build/api/contracts/integration/deployment.md +++ b/docs/clearnet/learn/contracts/integration/deployment.md @@ -2,7 +2,7 @@ title: "Deployment" description: "Deploying contracts and configuration." sidebar_position: 1 -displayed_sidebar: buildSidebar +displayed_sidebar: clearnetSidebar --- # Deployment diff --git a/docs/build/api/contracts/integration/events.md b/docs/clearnet/learn/contracts/integration/events.md similarity index 99% rename from docs/build/api/contracts/integration/events.md rename to docs/clearnet/learn/contracts/integration/events.md index cc3eaaa..245b5f3 100644 --- a/docs/build/api/contracts/integration/events.md +++ b/docs/clearnet/learn/contracts/integration/events.md @@ -2,7 +2,7 @@ title: "Events" description: "Contract events for real-time subscriptions." sidebar_position: 2 -displayed_sidebar: buildSidebar +displayed_sidebar: clearnetSidebar --- # Events diff --git a/docs/build/api/contracts/integration/ui-spec.md b/docs/clearnet/learn/contracts/integration/ui-spec.md similarity index 99% rename from docs/build/api/contracts/integration/ui-spec.md rename to docs/clearnet/learn/contracts/integration/ui-spec.md index 20140f8..a9a84f1 100644 --- a/docs/build/api/contracts/integration/ui-spec.md +++ b/docs/clearnet/learn/contracts/integration/ui-spec.md @@ -2,7 +2,7 @@ title: "UI Specification" description: "Frontend implementation guide." sidebar_position: 3 -displayed_sidebar: buildSidebar +displayed_sidebar: clearnetSidebar --- # UI Specification diff --git a/docs/build/api/contracts/protocol/_category_.json b/docs/clearnet/learn/contracts/protocol/_category_.json similarity index 100% rename from docs/build/api/contracts/protocol/_category_.json rename to docs/clearnet/learn/contracts/protocol/_category_.json diff --git a/docs/build/api/contracts/protocol/governance.md b/docs/clearnet/learn/contracts/protocol/governance.md similarity index 99% rename from docs/build/api/contracts/protocol/governance.md rename to docs/clearnet/learn/contracts/protocol/governance.md index 944fa07..52c2fb7 100644 --- a/docs/build/api/contracts/protocol/governance.md +++ b/docs/clearnet/learn/contracts/protocol/governance.md @@ -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 diff --git a/docs/build/api/contracts/protocol/overview.md b/docs/clearnet/learn/contracts/protocol/overview.md similarity index 99% rename from docs/build/api/contracts/protocol/overview.md rename to docs/clearnet/learn/contracts/protocol/overview.md index d3ee258..48b6a3c 100644 --- a/docs/build/api/contracts/protocol/overview.md +++ b/docs/clearnet/learn/contracts/protocol/overview.md @@ -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 diff --git a/docs/build/api/contracts/protocol/slashing.md b/docs/clearnet/learn/contracts/protocol/slashing.md similarity index 98% rename from docs/build/api/contracts/protocol/slashing.md rename to docs/clearnet/learn/contracts/protocol/slashing.md index 0f88eaf..d6d2744 100644 --- a/docs/build/api/contracts/protocol/slashing.md +++ b/docs/clearnet/learn/contracts/protocol/slashing.md @@ -2,7 +2,7 @@ title: "Slashing" description: "Adjudicator slashing and cooldown mechanism." sidebar_position: 4 -displayed_sidebar: buildSidebar +displayed_sidebar: clearnetSidebar --- # Slashing diff --git a/docs/build/api/contracts/protocol/staking.md b/docs/clearnet/learn/contracts/protocol/staking.md similarity index 99% rename from docs/build/api/contracts/protocol/staking.md rename to docs/clearnet/learn/contracts/protocol/staking.md index 0049c71..3ea7e57 100644 --- a/docs/build/api/contracts/protocol/staking.md +++ b/docs/clearnet/learn/contracts/protocol/staking.md @@ -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 diff --git a/docs/build/api/contracts/protocol/treasury.md b/docs/clearnet/learn/contracts/protocol/treasury.md similarity index 98% rename from docs/build/api/contracts/protocol/treasury.md rename to docs/clearnet/learn/contracts/protocol/treasury.md index add28c0..f4a0c70 100644 --- a/docs/build/api/contracts/protocol/treasury.md +++ b/docs/clearnet/learn/contracts/protocol/treasury.md @@ -2,7 +2,7 @@ title: "Treasury" description: "Foundation asset management." sidebar_position: 5 -displayed_sidebar: buildSidebar +displayed_sidebar: clearnetSidebar --- # Treasury diff --git a/docs/build/api/contracts/sdk/_category_.json b/docs/clearnet/learn/contracts/sdk/_category_.json similarity index 100% rename from docs/build/api/contracts/sdk/_category_.json rename to docs/clearnet/learn/contracts/sdk/_category_.json diff --git a/docs/build/api/contracts/sdk/api-reference.md b/docs/clearnet/learn/contracts/sdk/api-reference.md similarity index 98% rename from docs/build/api/contracts/sdk/api-reference.md rename to docs/clearnet/learn/contracts/sdk/api-reference.md index 033f31d..38c4baf 100644 --- a/docs/build/api/contracts/sdk/api-reference.md +++ b/docs/clearnet/learn/contracts/sdk/api-reference.md @@ -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 diff --git a/docs/build/api/contracts/sdk/examples.md b/docs/clearnet/learn/contracts/sdk/examples.md similarity index 99% rename from docs/build/api/contracts/sdk/examples.md rename to docs/clearnet/learn/contracts/sdk/examples.md index c338051..6b582a6 100644 --- a/docs/build/api/contracts/sdk/examples.md +++ b/docs/clearnet/learn/contracts/sdk/examples.md @@ -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 diff --git a/docs/build/api/contracts/sdk/getting-started.md b/docs/clearnet/learn/contracts/sdk/getting-started.md similarity index 98% rename from docs/build/api/contracts/sdk/getting-started.md rename to docs/clearnet/learn/contracts/sdk/getting-started.md index 8f5e48f..f179048 100644 --- a/docs/build/api/contracts/sdk/getting-started.md +++ b/docs/clearnet/learn/contracts/sdk/getting-started.md @@ -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 diff --git a/docs/protocol/decentralized-layer/_category_.json b/docs/clearnet/learn/decentralized-layer/_category_.json similarity index 100% rename from docs/protocol/decentralized-layer/_category_.json rename to docs/clearnet/learn/decentralized-layer/_category_.json diff --git a/docs/protocol/decentralized-layer/cluster-lifecycle.mdx b/docs/clearnet/learn/decentralized-layer/cluster-lifecycle.mdx similarity index 100% rename from docs/protocol/decentralized-layer/cluster-lifecycle.mdx rename to docs/clearnet/learn/decentralized-layer/cluster-lifecycle.mdx diff --git a/docs/protocol/decentralized-layer/elastic-security.mdx b/docs/clearnet/learn/decentralized-layer/elastic-security.mdx similarity index 100% rename from docs/protocol/decentralized-layer/elastic-security.mdx rename to docs/clearnet/learn/decentralized-layer/elastic-security.mdx diff --git a/docs/protocol/decentralized-layer/liquidity-layer.mdx b/docs/clearnet/learn/decentralized-layer/liquidity-layer.mdx similarity index 100% rename from docs/protocol/decentralized-layer/liquidity-layer.mdx rename to docs/clearnet/learn/decentralized-layer/liquidity-layer.mdx diff --git a/docs/protocol/decentralized-layer/overview.mdx b/docs/clearnet/learn/decentralized-layer/overview.mdx similarity index 100% rename from docs/protocol/decentralized-layer/overview.mdx rename to docs/clearnet/learn/decentralized-layer/overview.mdx diff --git a/docs/protocol/decentralized-layer/protocol-lifecycle.mdx b/docs/clearnet/learn/decentralized-layer/protocol-lifecycle.mdx similarity index 100% rename from docs/protocol/decentralized-layer/protocol-lifecycle.mdx rename to docs/clearnet/learn/decentralized-layer/protocol-lifecycle.mdx diff --git a/docs/protocol/decentralized-layer/security.mdx b/docs/clearnet/learn/decentralized-layer/security.mdx similarity index 100% rename from docs/protocol/decentralized-layer/security.mdx rename to docs/clearnet/learn/decentralized-layer/security.mdx diff --git a/docs/protocol/introduction.mdx b/docs/clearnet/learn/introduction.mdx similarity index 100% rename from docs/protocol/introduction.mdx rename to docs/clearnet/learn/introduction.mdx diff --git a/docs/api-reference/_category_.json b/docs/nitrolite/api-reference/_category_.json similarity index 100% rename from docs/api-reference/_category_.json rename to docs/nitrolite/api-reference/_category_.json diff --git a/docs/api-reference/app-sessions.md b/docs/nitrolite/api-reference/app-sessions.md similarity index 100% rename from docs/api-reference/app-sessions.md rename to docs/nitrolite/api-reference/app-sessions.md diff --git a/docs/api-reference/index.md b/docs/nitrolite/api-reference/index.md similarity index 100% rename from docs/api-reference/index.md rename to docs/nitrolite/api-reference/index.md diff --git a/docs/build/_category_.json b/docs/nitrolite/build/_category_.json similarity index 100% rename from docs/build/_category_.json rename to docs/nitrolite/build/_category_.json diff --git a/docs/build/getting-started/_category_.json b/docs/nitrolite/build/getting-started/_category_.json similarity index 100% rename from docs/build/getting-started/_category_.json rename to docs/nitrolite/build/getting-started/_category_.json diff --git a/docs/build/getting-started/key-terms.mdx b/docs/nitrolite/build/getting-started/key-terms.mdx similarity index 97% rename from docs/build/getting-started/key-terms.mdx rename to docs/nitrolite/build/getting-started/key-terms.mdx index a079a9f..876926f 100644 --- a/docs/build/getting-started/key-terms.mdx +++ b/docs/nitrolite/build/getting-started/key-terms.mdx @@ -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 \ No newline at end of file +- **[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 \ No newline at end of file diff --git a/docs/build/getting-started/prerequisites.mdx b/docs/nitrolite/build/getting-started/prerequisites.mdx similarity index 98% rename from docs/build/getting-started/prerequisites.mdx rename to docs/nitrolite/build/getting-started/prerequisites.mdx index 5cb7a52..6b5dc87 100644 --- a/docs/build/getting-started/prerequisites.mdx +++ b/docs/nitrolite/build/getting-started/prerequisites.mdx @@ -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 --- diff --git a/docs/build/getting-started/quickstart.mdx b/docs/nitrolite/build/getting-started/quickstart.mdx similarity index 100% rename from docs/build/getting-started/quickstart.mdx rename to docs/nitrolite/build/getting-started/quickstart.mdx diff --git a/docs/build/quick-start/index.md b/docs/nitrolite/build/quick-start/index.md similarity index 99% rename from docs/build/quick-start/index.md rename to docs/nitrolite/build/quick-start/index.md index 75cad82..e9ae8c3 100644 --- a/docs/build/quick-start/index.md +++ b/docs/nitrolite/build/quick-start/index.md @@ -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 diff --git a/docs/build/sdk/_category_.json b/docs/nitrolite/build/sdk/_category_.json similarity index 79% rename from docs/build/sdk/_category_.json rename to docs/nitrolite/build/sdk/_category_.json index 32cf882..4a71e07 100644 --- a/docs/build/sdk/_category_.json +++ b/docs/nitrolite/build/sdk/_category_.json @@ -1,6 +1,6 @@ { "label": "SDK", - "position": 2, + "position": 3, "collapsed": false, "collapsible": false } diff --git a/docs/build/sdk/go/_category_.json b/docs/nitrolite/build/sdk/go/_category_.json similarity index 80% rename from docs/build/sdk/go/_category_.json rename to docs/nitrolite/build/sdk/go/_category_.json index 3a2be2d..593eb15 100644 --- a/docs/build/sdk/go/_category_.json +++ b/docs/nitrolite/build/sdk/go/_category_.json @@ -1,6 +1,6 @@ { "label": "Go SDK", - "position": 4, + "position": 6, "collapsed": false, "collapsible": false } diff --git a/docs/build/sdk/go/api-reference.mdx b/docs/nitrolite/build/sdk/go/api-reference.mdx similarity index 100% rename from docs/build/sdk/go/api-reference.mdx rename to docs/nitrolite/build/sdk/go/api-reference.mdx diff --git a/docs/build/sdk/go/getting-started.mdx b/docs/nitrolite/build/sdk/go/getting-started.mdx similarity index 100% rename from docs/build/sdk/go/getting-started.mdx rename to docs/nitrolite/build/sdk/go/getting-started.mdx diff --git a/docs/build/sdk/index.md b/docs/nitrolite/build/sdk/index.md similarity index 100% rename from docs/build/sdk/index.md rename to docs/nitrolite/build/sdk/index.md diff --git a/docs/build/sdk/migration-guide.md b/docs/nitrolite/build/sdk/migration-guide.md similarity index 100% rename from docs/build/sdk/migration-guide.md rename to docs/nitrolite/build/sdk/migration-guide.md diff --git a/docs/build/sdk/multi-party-app-sessions.mdx b/docs/nitrolite/build/sdk/multi-party-app-sessions.mdx similarity index 98% rename from docs/build/sdk/multi-party-app-sessions.mdx rename to docs/nitrolite/build/sdk/multi-party-app-sessions.mdx index 925d880..1262dda 100644 --- a/docs/build/sdk/multi-party-app-sessions.mdx +++ b/docs/nitrolite/build/sdk/multi-party-app-sessions.mdx @@ -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 diff --git a/docs/build/sdk/typescript-compat/_category_.json b/docs/nitrolite/build/sdk/typescript-compat/_category_.json similarity index 83% rename from docs/build/sdk/typescript-compat/_category_.json rename to docs/nitrolite/build/sdk/typescript-compat/_category_.json index 5139e8f..28b66b7 100644 --- a/docs/build/sdk/typescript-compat/_category_.json +++ b/docs/nitrolite/build/sdk/typescript-compat/_category_.json @@ -1,6 +1,6 @@ { "label": "TypeScript Compat SDK", - "position": 3, + "position": 5, "collapsed": false, "collapsible": false } diff --git a/docs/build/sdk/typescript-compat/migration-offchain.mdx b/docs/nitrolite/build/sdk/typescript-compat/migration-offchain.mdx similarity index 100% rename from docs/build/sdk/typescript-compat/migration-offchain.mdx rename to docs/nitrolite/build/sdk/typescript-compat/migration-offchain.mdx diff --git a/docs/build/sdk/typescript-compat/migration-onchain.mdx b/docs/nitrolite/build/sdk/typescript-compat/migration-onchain.mdx similarity index 100% rename from docs/build/sdk/typescript-compat/migration-onchain.mdx rename to docs/nitrolite/build/sdk/typescript-compat/migration-onchain.mdx diff --git a/docs/build/sdk/typescript-compat/migration-overview.mdx b/docs/nitrolite/build/sdk/typescript-compat/migration-overview.mdx similarity index 100% rename from docs/build/sdk/typescript-compat/migration-overview.mdx rename to docs/nitrolite/build/sdk/typescript-compat/migration-overview.mdx diff --git a/docs/build/sdk/typescript-compat/overview.mdx b/docs/nitrolite/build/sdk/typescript-compat/overview.mdx similarity index 100% rename from docs/build/sdk/typescript-compat/overview.mdx rename to docs/nitrolite/build/sdk/typescript-compat/overview.mdx diff --git a/docs/build/sdk/typescript/_category_.json b/docs/nitrolite/build/sdk/typescript/_category_.json similarity index 82% rename from docs/build/sdk/typescript/_category_.json rename to docs/nitrolite/build/sdk/typescript/_category_.json index 9fdfa4a..d58d148 100644 --- a/docs/build/sdk/typescript/_category_.json +++ b/docs/nitrolite/build/sdk/typescript/_category_.json @@ -1,6 +1,6 @@ { "label": "TypeScript SDK", - "position": 2, + "position": 4, "collapsed": false, "collapsible": false } diff --git a/docs/build/sdk/typescript/api-reference.mdx b/docs/nitrolite/build/sdk/typescript/api-reference.mdx similarity index 100% rename from docs/build/sdk/typescript/api-reference.mdx rename to docs/nitrolite/build/sdk/typescript/api-reference.mdx diff --git a/docs/build/sdk/typescript/configuration.mdx b/docs/nitrolite/build/sdk/typescript/configuration.mdx similarity index 100% rename from docs/build/sdk/typescript/configuration.mdx rename to docs/nitrolite/build/sdk/typescript/configuration.mdx diff --git a/docs/build/sdk/typescript/examples.mdx b/docs/nitrolite/build/sdk/typescript/examples.mdx similarity index 100% rename from docs/build/sdk/typescript/examples.mdx rename to docs/nitrolite/build/sdk/typescript/examples.mdx diff --git a/docs/build/sdk/typescript/getting-started.mdx b/docs/nitrolite/build/sdk/typescript/getting-started.mdx similarity index 100% rename from docs/build/sdk/typescript/getting-started.mdx rename to docs/nitrolite/build/sdk/typescript/getting-started.mdx diff --git a/docs/learn/_category_.json b/docs/nitrolite/learn/_category_.json similarity index 100% rename from docs/learn/_category_.json rename to docs/nitrolite/learn/_category_.json diff --git a/docs/learn/core-concepts/_category_.json b/docs/nitrolite/learn/core-concepts/_category_.json similarity index 100% rename from docs/learn/core-concepts/_category_.json rename to docs/nitrolite/learn/core-concepts/_category_.json diff --git a/docs/learn/core-concepts/challenge-response.mdx b/docs/nitrolite/learn/core-concepts/challenge-response.mdx similarity index 97% rename from docs/learn/core-concepts/challenge-response.mdx rename to docs/nitrolite/learn/core-concepts/challenge-response.mdx index 4bf2d23..30e7b4c 100644 --- a/docs/learn/core-concepts/challenge-response.mdx +++ b/docs/nitrolite/learn/core-concepts/challenge-response.mdx @@ -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. diff --git a/docs/learn/core-concepts/state-channels-vs-l1-l2.mdx b/docs/nitrolite/learn/core-concepts/state-channels-vs-l1-l2.mdx similarity index 97% rename from docs/learn/core-concepts/state-channels-vs-l1-l2.mdx rename to docs/nitrolite/learn/core-concepts/state-channels-vs-l1-l2.mdx index 6bfbf8a..c35cc85 100644 --- a/docs/learn/core-concepts/state-channels-vs-l1-l2.mdx +++ b/docs/nitrolite/learn/core-concepts/state-channels-vs-l1-l2.mdx @@ -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 diff --git a/docs/learn/core-concepts/yellow-token.mdx b/docs/nitrolite/learn/core-concepts/yellow-token.mdx similarity index 100% rename from docs/learn/core-concepts/yellow-token.mdx rename to docs/nitrolite/learn/core-concepts/yellow-token.mdx diff --git a/docs/learn/index.mdx b/docs/nitrolite/learn/index.mdx similarity index 94% rename from docs/learn/index.mdx rename to docs/nitrolite/learn/index.mdx index 7a7ff3f..5ebed62 100644 --- a/docs/learn/index.mdx +++ b/docs/nitrolite/learn/index.mdx @@ -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 --- diff --git a/docs/learn/introduction/_category_.json b/docs/nitrolite/learn/introduction/_category_.json similarity index 100% rename from docs/learn/introduction/_category_.json rename to docs/nitrolite/learn/introduction/_category_.json diff --git a/docs/learn/introduction/architecture-at-a-glance.mdx b/docs/nitrolite/learn/introduction/architecture-at-a-glance.mdx similarity index 96% rename from docs/learn/introduction/architecture-at-a-glance.mdx rename to docs/nitrolite/learn/introduction/architecture-at-a-glance.mdx index 8fa19c6..726c096 100644 --- a/docs/learn/introduction/architecture-at-a-glance.mdx +++ b/docs/nitrolite/learn/introduction/architecture-at-a-glance.mdx @@ -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 @@ -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 diff --git a/docs/learn/introduction/supported-chains.mdx b/docs/nitrolite/learn/introduction/supported-chains.mdx similarity index 96% rename from docs/learn/introduction/supported-chains.mdx rename to docs/nitrolite/learn/introduction/supported-chains.mdx index 044617f..877cee7 100644 --- a/docs/learn/introduction/supported-chains.mdx +++ b/docs/nitrolite/learn/introduction/supported-chains.mdx @@ -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 diff --git a/docs/learn/introduction/what-yellow-solves.mdx b/docs/nitrolite/learn/introduction/what-yellow-solves.mdx similarity index 98% rename from docs/learn/introduction/what-yellow-solves.mdx rename to docs/nitrolite/learn/introduction/what-yellow-solves.mdx index 3535fa0..87f7c93 100644 --- a/docs/learn/introduction/what-yellow-solves.mdx +++ b/docs/nitrolite/learn/introduction/what-yellow-solves.mdx @@ -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 diff --git a/docs/learn/protocol-flows/_category_.json b/docs/nitrolite/learn/protocol-flows/_category_.json similarity index 100% rename from docs/learn/protocol-flows/_category_.json rename to docs/nitrolite/learn/protocol-flows/_category_.json diff --git a/docs/learn/protocol-flows/app-session-deposit.mdx b/docs/nitrolite/learn/protocol-flows/app-session-deposit.mdx similarity index 100% rename from docs/learn/protocol-flows/app-session-deposit.mdx rename to docs/nitrolite/learn/protocol-flows/app-session-deposit.mdx diff --git a/docs/learn/protocol-flows/architecture.mdx b/docs/nitrolite/learn/protocol-flows/architecture.mdx similarity index 100% rename from docs/learn/protocol-flows/architecture.mdx rename to docs/nitrolite/learn/protocol-flows/architecture.mdx diff --git a/docs/learn/protocol-flows/escrow-deposit.mdx b/docs/nitrolite/learn/protocol-flows/escrow-deposit.mdx similarity index 100% rename from docs/learn/protocol-flows/escrow-deposit.mdx rename to docs/nitrolite/learn/protocol-flows/escrow-deposit.mdx diff --git a/docs/learn/protocol-flows/escrow-withdrawal.mdx b/docs/nitrolite/learn/protocol-flows/escrow-withdrawal.mdx similarity index 100% rename from docs/learn/protocol-flows/escrow-withdrawal.mdx rename to docs/nitrolite/learn/protocol-flows/escrow-withdrawal.mdx diff --git a/docs/learn/protocol-flows/home-channel-creation.mdx b/docs/nitrolite/learn/protocol-flows/home-channel-creation.mdx similarity index 100% rename from docs/learn/protocol-flows/home-channel-creation.mdx rename to docs/nitrolite/learn/protocol-flows/home-channel-creation.mdx diff --git a/docs/learn/protocol-flows/home-channel-deposit.mdx b/docs/nitrolite/learn/protocol-flows/home-channel-deposit.mdx similarity index 100% rename from docs/learn/protocol-flows/home-channel-deposit.mdx rename to docs/nitrolite/learn/protocol-flows/home-channel-deposit.mdx diff --git a/docs/learn/protocol-flows/home-channel-withdraw-on-create.mdx b/docs/nitrolite/learn/protocol-flows/home-channel-withdraw-on-create.mdx similarity index 100% rename from docs/learn/protocol-flows/home-channel-withdraw-on-create.mdx rename to docs/nitrolite/learn/protocol-flows/home-channel-withdraw-on-create.mdx diff --git a/docs/learn/protocol-flows/home-channel-withdrawal.mdx b/docs/nitrolite/learn/protocol-flows/home-channel-withdrawal.mdx similarity index 100% rename from docs/learn/protocol-flows/home-channel-withdrawal.mdx rename to docs/nitrolite/learn/protocol-flows/home-channel-withdrawal.mdx diff --git a/docs/learn/protocol-flows/transfer-flow.mdx b/docs/nitrolite/learn/protocol-flows/transfer-flow.mdx similarity index 100% rename from docs/learn/protocol-flows/transfer-flow.mdx rename to docs/nitrolite/learn/protocol-flows/transfer-flow.mdx diff --git a/docs/protocol/_category_.json b/docs/nitrolite/protocol/_category_.json similarity index 100% rename from docs/protocol/_category_.json rename to docs/nitrolite/protocol/_category_.json diff --git a/docs/protocol/protocol-reference.mdx b/docs/nitrolite/protocol/protocol-reference.mdx similarity index 100% rename from docs/protocol/protocol-reference.mdx rename to docs/nitrolite/protocol/protocol-reference.mdx diff --git a/docs/protocol/terminology.mdx b/docs/nitrolite/protocol/terminology.mdx similarity index 100% rename from docs/protocol/terminology.mdx rename to docs/nitrolite/protocol/terminology.mdx diff --git a/docs/tutorials/_category_.json b/docs/nitrolite/tutorials/_category_.json similarity index 100% rename from docs/tutorials/_category_.json rename to docs/nitrolite/tutorials/_category_.json diff --git a/docs/tutorials/index.md b/docs/nitrolite/tutorials/index.md similarity index 100% rename from docs/tutorials/index.md rename to docs/nitrolite/tutorials/index.md diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 0c15747..375be78 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -59,8 +59,9 @@ const config: Config = { 'classic', { docs: { - sidebarPath: './sidebars.ts', - routeBasePath: '/docs', + path: './docs/nitrolite', + sidebarPath: './sidebars-nitrolite.ts', + routeBasePath: '/nitrolite', editUrl: 'https://github.com/layer-3/docs/tree/master/', sidebarCollapsed: false, @@ -93,6 +94,20 @@ const config: Config = { }, themes: ['@docusaurus/theme-mermaid'], plugins: [ + [ + '@docusaurus/plugin-content-docs', + { + id: 'clearnet', + path: './docs/clearnet', + routeBasePath: '/clearnet', + sidebarPath: './sidebars-clearnet.ts', + editUrl: 'https://github.com/layer-3/docs/tree/master/', + sidebarCollapsed: false, + sidebarCollapsible: false, + breadcrumbs: true, + // No versions block — Clearnet starts unversioned + }, + ], [ 'docusaurus-lunr-search', { @@ -118,39 +133,78 @@ const config: Config = { srcDark: 'img/themes/dark/logo.svg', }, items: [ + // Portal-only product entry links + { + to: '/nitrolite', + label: 'Nitrolite', + position: 'left', + customProps: { showOn: 'portal' }, + }, + { + to: '/clearnet/learn/introduction', + label: 'Clearnet', + position: 'left', + customProps: { showOn: 'portal' }, + }, + // Nitrolite navbar items (shown on /nitrolite/*) { type: 'doc', docId: 'learn/index', label: 'Learn', position: 'left', + customProps: { showOn: 'nitrolite' }, }, { type: 'doc', docId: 'build/quick-start/index', label: 'Build', position: 'left', + customProps: { showOn: 'nitrolite' }, }, { type: 'doc', - docId: 'protocol/introduction', + docId: 'protocol/protocol-reference', label: 'Protocol', position: 'left', + customProps: { showOn: 'nitrolite' }, + }, + { + type: 'doc', + docId: 'guides/index', + label: 'Guides', + position: 'left', + customProps: { showOn: 'nitrolite', onlyIfPathStartsWith: '/nitrolite/0.5.x' }, + }, + // Clearnet navbar items (shown on /clearnet/*) — single "Learn" entry + // is a plain link to Introduction, not a doc reference, so the navbar + // item itself doesn't represent a page. + { + to: '/clearnet/learn/introduction', + label: 'Learn', + position: 'left', + customProps: { showOn: 'clearnet' }, }, + // Whitepaper only on portal { to: '/whitepaper', label: 'Whitepaper', position: 'left', + customProps: { showOn: 'portal' }, }, + // GitHub link visible on all sub-sites { - href: 'https://github.com/layer-3', + href: 'https://github.com/layer-3/docs', position: 'right', className: 'header-github-link', 'aria-label': 'GitHub repository', + customProps: { showOn: 'all' }, }, + // Version dropdown only on Nitrolite (Clearnet is unversioned). { type: 'docsVersionDropdown', position: 'right', className: 'navbar-version-dropdown', + customProps: { showOn: 'nitrolite' }, }, ], }, @@ -169,16 +223,42 @@ const config: Config = { ], }, { - title: 'Docs', + title: 'Nitrolite', items: [ { label: 'Learn', - to: '/docs/learn', + to: '/nitrolite/learn', }, { label: 'Build', - to: '/docs/build/quick-start', + to: '/nitrolite/build/quick-start', }, + { + label: 'Protocol', + to: '/nitrolite/protocol/terminology', + }, + ], + }, + { + title: 'Clearnet', + items: [ + { + label: 'Introduction', + to: '/clearnet/learn/introduction', + }, + { + label: 'Architecture', + to: '/clearnet/learn/architecture', + }, + { + label: 'Contracts', + to: '/clearnet/learn/contracts', + }, + ], + }, + { + title: 'More', + items: [ { label: 'Whitepaper', to: '/whitepaper', @@ -188,6 +268,10 @@ const config: Config = { { title: 'Community', items: [ + { + label: 'Telegram', + href: 'https://t.me/YellowSDKCommunity', + }, { label: 'Discord', href: 'https://discord.com/invite/yellownetwork', diff --git a/sidebars-clearnet.ts b/sidebars-clearnet.ts new file mode 100644 index 0000000..ec394e7 --- /dev/null +++ b/sidebars-clearnet.ts @@ -0,0 +1,28 @@ +import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; + +// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...) + +const sidebars: SidebarsConfig = { + clearnetSidebar: [ + 'learn/introduction', + 'learn/architecture', + { + type: 'category', + label: 'Decentralized Layer', + items: [ + {type: 'autogenerated', dirName: 'learn/decentralized-layer'}, + ], + collapsed: false, + }, + { + type: 'category', + label: 'Contracts', + items: [ + {type: 'autogenerated', dirName: 'learn/contracts'}, + ], + collapsed: false, + }, + ], +}; + +export default sidebars; diff --git a/sidebars.ts b/sidebars-nitrolite.ts similarity index 89% rename from sidebars.ts rename to sidebars-nitrolite.ts index 315f6ac..e905768 100644 --- a/sidebars.ts +++ b/sidebars-nitrolite.ts @@ -28,7 +28,6 @@ const sidebars: SidebarsConfig = { 'learn/introduction/architecture-at-a-glance', 'learn/introduction/supported-chains', ], - collapsible: false, collapsed: false, }, { @@ -39,7 +38,6 @@ const sidebars: SidebarsConfig = { 'learn/core-concepts/challenge-response', 'learn/core-concepts/yellow-token', ], - collapsible: false, collapsed: false, }, { @@ -48,7 +46,6 @@ const sidebars: SidebarsConfig = { items: [ {type: 'autogenerated', dirName: 'learn/protocol-flows'}, ], - collapsible: false, collapsed: false, }, ], @@ -77,12 +74,11 @@ const sidebars: SidebarsConfig = { }, ], - // Protocol section sidebar + // Protocol section sidebar — only protocol-reference and terminology remain + // (introduction, architecture, decentralized-layer moved to Clearnet) protocolSidebar: [ - { - type: 'autogenerated', - dirName: 'protocol', - }, + 'protocol/protocol-reference', + 'protocol/terminology', ], // Default sidebar for standalone pages diff --git a/src/components/HomepageFeatures/index.tsx b/src/components/HomepageFeatures/index.tsx index cbc0e05..b1bea0e 100644 --- a/src/components/HomepageFeatures/index.tsx +++ b/src/components/HomepageFeatures/index.tsx @@ -17,66 +17,40 @@ type FeatureItem = { const FeatureList: FeatureItem[] = [ { - title: 'Learn the Basics', - imageSrc: require('@site/static/img/themes/light/icons/learn.png').default, - imageSrcDark: require('@site/static/img/themes/dark/icons/learn.png').default, - description: ( - <> - Understand the fundamentals of Yellow Network, its architecture, - and how decentralized clearing and settlement works. - - ), - link: '/docs/learn', - }, - { - title: 'Build a Yellow App', + title: 'Nitrolite', imageSrc: require('@site/static/img/themes/light/icons/build.png').default, imageSrcDark: require('@site/static/img/themes/dark/icons/build.png').default, description: ( <> - Create decentralized applications using Yellow SDK with real-time - trading capabilities and instant cross-chain settlements. + State channel SDK for building decentralized apps with instant + finality, real-time trading, and cross-chain settlement. ), - link: '/docs/build/quick-start', + link: '/nitrolite', }, { - title: 'Run a Clearnode', + title: 'Clearnet', imageSrc: require('@site/static/img/themes/light/icons/clearnode.png').default, imageSrcDark: require('@site/static/img/themes/dark/icons/clearnode.png').default, description: ( <> - Set up and operate a clearnode to provide network services - and contribute to decentralized infrastructure. + Decentralized clearing and settlement protocol — peer-to-peer overlay + network, smart contracts, governance, and node operations. ), - link: '/docs/learn', + link: '/clearnet/learn/introduction', }, { - title: 'Join the Community', - imageSrc: require('@site/static/img/themes/light/icons/community.png').default, - imageSrcDark: require('@site/static/img/themes/dark/icons/community.png').default, - description: ( - <> - Connect with developers, traders, and node operators in our - Discord community and contribute to the ecosystem. - - ), - link: 'https://discord.com/invite/yellownetwork', - isExternal: true, - }, - { - title: 'Apply for Grants', - imageSrc: require('@site/static/img/themes/light/icons/grants.png').default, - imageSrcDark: require('@site/static/img/themes/dark/icons/grants.png').default, + title: 'Whitepaper', + imageSrc: require('@site/static/img/themes/light/icons/learn.png').default, + imageSrcDark: require('@site/static/img/themes/dark/icons/learn.png').default, description: ( <> - Get funding support for your Yellow Network project through - our grants program for innovative applications and integrations. + The Yellow Network whitepaper — protocol design, economic model, + and technical reference for the decentralized clearing layer. ), - link: 'https://forms.yellow.org/build', - isExternal: true, + link: '/whitepaper', }, ]; @@ -89,7 +63,7 @@ function Feature({title, imageSrc, imageSrcDark, description, link, isExternal}: : { to: link }; return ( -
+
-
+
{FeatureList.map((props, idx) => ( ))} diff --git a/src/css/custom.css b/src/css/custom.css index b5e9667..c8634c9 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -26,7 +26,7 @@ --ifm-font-weight-base: 300; --ifm-font-weight-semibold: 500; --ifm-font-weight-bold: 500; - --doc-sidebar-width: 315px; + --doc-sidebar-width: 270px; --ifm-navbar-search-input-icon: url('data:image/svg+xml;utf8,'); } @@ -69,8 +69,8 @@ font-family: 'Poppins', sans-serif !important; font-weight: 300 !important; font-style: normal !important; - font-size: 16px !important; - line-height: 24px !important; + font-size: 15px !important; + line-height: 17px !important; letter-spacing: 0.15px !important; vertical-align: middle !important; } @@ -82,8 +82,8 @@ font-family: 'Poppins', sans-serif !important; font-weight: 500 !important; font-style: normal !important; - font-size: 16px !important; - line-height: 24px !important; + font-size: 15px !important; + line-height: 17px !important; letter-spacing: 0.15px !important; vertical-align: middle !important; } @@ -143,9 +143,11 @@ a.menu__link--active { background-color: #EDEDED; } -/* Level 3 items border positioning */ +/* Level 3 leaf vertical line: align with the level-2 collapsible chevron, + * which sits at padding-left: 32px on its container. + */ .menu__list .menu__list .menu__list .menu__link:not(.menu__link--sublist):not(.menu__link--sublist-caret)::before { - left: 8px; + left: 12px; } /* Add proper padding for all sidebar items with borders */ @@ -153,17 +155,30 @@ a.menu__link--active { position: relative; } -/* Add extra spacing only for sub-items (level-2 items under categories) */ +/* Double the default horizontal padding of the central doc content column */ +[class*='docItemCol'] { + padding: 0 40px !important; +} + +/* Nested indentation — each level shifts further right */ .theme-doc-sidebar-item-link-level-2 .menu__link { padding-left: 32px !important; } -.menu__list .menu__list .menu__link { - padding-left: 24px !important; +.menu__list .menu__list .menu__link:not(.menu__link--sublist) { + padding-left: 20px !important; } -.menu__list .menu__list .menu__list .menu__link { - padding-left: 32px !important; +/* Level-2 category headers (e.g. "TypeScript SDK" under "SDK") — + * chevron at 28px so it aligns with sibling doc items */ +.menu__list .menu__list .menu__list-item-collapsible, +.menu__list .menu__list .menu__list-item-collapsible--active, +.menu__list .menu__list .menu__list-item-collapsible:hover { + padding-left: 28px !important; +} + +.menu__list .menu__list .menu__list .menu__link:not(.menu__link--sublist) { + padding-left: 36px !important; } /* Table of contents styling - use darker/lighter colors instead of theme colors */ @@ -208,6 +223,23 @@ a.table-of-contents__link.table-of-contents__link--active code { color: #cccccc !important; } +/* Remove left padding from the right TOC column */ +.col.col--3 { + padding-left: 0 !important; +} + +/* "ON THIS PAGE:" heading above the TOC */ +.theme-doc-toc-desktop::before { + content: 'ON THIS PAGE:'; + display: block; + font-family: 'Poppins', sans-serif; + font-size: 13px; + font-weight: 500; + letter-spacing: 0.08em; + margin-bottom: 12px; + margin-left: 6px; +} + /* Pagination navigation styling */ .pagination-nav__link { border: 1px solid #e0e0e0 !important; @@ -340,11 +372,14 @@ a.table-of-contents__link.table-of-contents__link--active code { -/* Remove black border and styling for parent categories (categories with subcategories) */ +/* Remove black border and styling for parent categories (categories with subcategories). + * Padding is intentionally NOT set here — the chevron + label spacing is owned by + * .menu__list-item-collapsible (flex container with gap). Setting padding-left on + * the link would shift the label text away from the chevron when a child is active. + */ .menu__link--sublist.menu__link--active, a.menu__link.menu__link--sublist.menu__link--active { border-left: none !important; - padding-left: 16px !important; font-weight: 600; background: transparent !important; background-color: transparent !important; @@ -367,57 +402,181 @@ a.menu__link.menu__link--sublist.menu__link--active:hover { color: #cccccc !important; } -/* Move expand/collapse icon to the left side of text */ -.menu__link--sublist, -.menu__list-item-collapsible>.menu__link { +/* Sidebar collapsible category: chevron-only toggle. + * The .menu__caret