Documentation

// NOTE: Info-source reference only — NOT a sidebar navigation item. // See docs/en/for-founders.mdx for the full policy note. // Sidebar section order = AUDIENCE_CURATED_DOCS.developer key order (system layers).

For Developers

Curated index for developers, integrators, and engineers. Hubs follow system layers (Architecture → API → Features → Deploy → Development/MCP). The sidebar Developer tab mirrors this via lib/docs/audience-curated-docs.ts. Founders see Features / Examples / Customization / Web3 first — flip the sidebar tab anytime.

Flip Founder / Developer in the docs sidebar anytime. Operator journey hubs live on For Founders.

1. Bootstrap

Getting Started →

2. System architecture

Architecture → · Backend →

Backend Modes and Databases
Data Model
Data Validation
Authentication
Security
Real-Time
Discovery Mutation Sync
Proxy and i18n
PaymentConductor
WalletConductor — facade adapters, rates, /api/wallet/*
Refcodes
News Kingdom
Email AI-CRM
k3s + Postgres + FCM
Firebase — Hosting rewrites + Cloud Scheduler for ProcessConductor /api/cron/* (schedule catalog = vercel.json)

3. API contracts

API Reference → — visual RingApiTree widget + ~244 App Router /api/* handlers (truth as of 2026-07-10).

Authentication
Entities
Opportunities
Messaging — verified /api/conversations types (direct|entity|opportunity|product|group); no channel
Notifications
Wallet
Store — PaymentConductor store_order (no fabricated cart REST)
Admin — includes user Payments tab
Email AI-CRM
Ring MCP — /api/mcp/v1/*
Tunnel protocol — /api/tunnel/*

4. Payments cluster (ordered)

Features →

PaymentConductor
Ring Oracle — server-only rate facade, FX cron, conversion API, SSR hydrate, and checkout presentment
WayForPay Integration
SubscriptionConductor — multi-provider ledger including telegram_stars
Payments overview
Public Pools & DAO Jars — public_pool_contribution, desk FX, builder payout, escrow gate
Store
Wallet
WalletConductor — custodial native + credit orchestration (top-up, desk, spend, NFT buy)
Credit Rewards — credit.rewards.enabled, enqueueRewardCreditAddEvent, UserProgressWidget
Refcodes
Affiliates
NFT Marketplace — ledger-dev RING settlement, KEYS listing policy, sale ledger
Solana NFT Gates — Metaplex Core + GateEscrow + stake-to-activate
Staking
Owner Project Lab — /my-orders, order_lab room, /admin/crm/orders
Ops checklist: Payment integration

5. Product features

Realtime & communication

Tunnel Protocol
Messaging — Conversation.type vs metadata.kind; inbox hide for tool chats
Ring Tasks — task message type, /tasks tree, credit escrow, convert → request opportunity
WebRTC Calls & STUNner
Peer Games — /games, game_request, Tunnel+DB SSOT (tic-tac-toe, chess, checkers); P1 expiry/ACL/FCM/DataChannel hints
Push Notifications (FCM)
Notifications
Email AI-CRM — UI /admin/crm/*; APIs /api/admin/email/*
Ring Mailer & RingdomX — own SMTP / Ethereal; calculator mail add-on
Owner Project Lab — buyer My Projects + shared order_lab + CRM order desk

Identity, trust, content

Authentication — Auth.js providers including Telegram OIDC + Mini App initData
Security
Admin console — admin-nav-config SSOT, CrmAdminShell tabs, Security/Matcher tabs
Admin Wiki — Postgres Markdown vault, [[wikilinks]], ring-wiki-* MCP
Manage via Telegram — admin bot RBAC + webhook (not member Login / Mini App)
Entities
Opportunities
AI Matcher
News — TipTap NewsEditor, pending-revision APIs, sanitizeNewsHtml
Member Blog
Public Profile
Profile Account Widgets — /profile Organization Davinci-droplist, Position/Skills tag clouds, My CV FsModal
File Cabinet — member-gated /file-cabinet, subscriber+ /profile/shared, gallery, public /{username}/img
Username Reservation
Scientific Editor — publications TipTap JSON + versions (not news)
Locale System
Doc System

Media, UX, ERP

VideoConductor
MediaConductor — Audible radio-host TTS + Agent NODUS (docs_article_enrichment, /llms.txt, /nodus.json) + Visual walkthrough
Generative Gallery — features/generative-media/, Ghost-write + ImageConductor, WebP, hidden genmedia: chats
Mobile Experience
Performance
ERP — Inventory · Vendor management · Commissions

6. Deploy & env

Deployment → · Configuration →

Environment — full env.local.template reference
Public vars · Secrets — Order Lab ownership taxonomy
WalletConnect Project ID · Supported services
NODUS wiki · Playbook
Self-Hosted
Docker
Vercel — vercel.json crons[] must list every ProcessConductor cronPath; Bearer CRON_SECRET
Monitoring
Performance
Backup

7a. Engineering core

Development →

Local Setup
Code Structure
Code Style
Best Practices
Testing
Debugging
Performance
Workflow
Contributing
Deployment
Docs Components
Community Tooling
Ring MCP
Whitelabel Navigation — closed Lucide map, pack primary-nav.ts, overlay remap-only
OSS vs Enterprise

7b. Generative media + MCP

8. Customize & examples

Customization → · Examples →

Customization: quick-start, guide, vertical presets, ringization playbook, localization (Layer1 → pack.json → overlay), database-selection, token-economics, payment-integration, AI, branding, features, themes, components
Examples: quick-start, basic-setup, authentication, email-ai-crm, api-integration, api-examples, web3-integration, white-label, custom-branding, apple-signin, integrations, real-world, advanced-features
Ethereum Wallets
Token Launch Jurisdictions
Wallet Security Tips

Reference

Roadmap · Docs hub · For Founders · Vendor Guide

Developers optimize for architecture, performance, and correctness. Use the sidebar to flip to Founder for operator journey hubs.

Updated Sep 9, 20265 min listen

// NOTE: Info-source reference only — NOT a sidebar navigation item. // See docs/en/for-founders.mdx for the full policy note. // Sidebar section order = AUDIENCE_CURATED_DOCS.developer key order (system layers).

For Developers

Curated index for developers, integrators, and engineers. Hubs follow system layers (Architecture → API → Features → Deploy → Development/MCP). The sidebar Developer tab mirrors this via lib/docs/audience-curated-docs.ts. Founders see Features / Examples / Customization / Web3 first — flip the sidebar tab anytime.

Flip Founder / Developer in the docs sidebar anytime. Operator journey hubs live on For Founders.

1. Bootstrap

Getting Started →

2. System architecture

Architecture → · Backend →

Backend Modes and Databases
Data Model
Data Validation
Authentication
Security
Real-Time
Discovery Mutation Sync
Proxy and i18n
PaymentConductor
WalletConductor — facade adapters, rates, /api/wallet/*
Refcodes
News Kingdom
Email AI-CRM
k3s + Postgres + FCM
Firebase — Hosting rewrites + Cloud Scheduler for ProcessConductor /api/cron/* (schedule catalog = vercel.json)

3. API contracts

API Reference → — visual RingApiTree widget + ~244 App Router /api/* handlers (truth as of 2026-07-10).

Authentication
Entities
Opportunities
Messaging — verified /api/conversations types (direct|entity|opportunity|product|group); no channel
Notifications
Wallet
Store — PaymentConductor store_order (no fabricated cart REST)
Admin — includes user Payments tab
Email AI-CRM
Ring MCP — /api/mcp/v1/*
Tunnel protocol — /api/tunnel/*

4. Payments cluster (ordered)

Features →

PaymentConductor
Ring Oracle — server-only rate facade, FX cron, conversion API, SSR hydrate, and checkout presentment
WayForPay Integration
SubscriptionConductor — multi-provider ledger including telegram_stars
Payments overview
Public Pools & DAO Jars — public_pool_contribution, desk FX, builder payout, escrow gate
Store
Wallet
WalletConductor — custodial native + credit orchestration (top-up, desk, spend, NFT buy)
Credit Rewards — credit.rewards.enabled, enqueueRewardCreditAddEvent, UserProgressWidget
Refcodes
Affiliates
NFT Marketplace — ledger-dev RING settlement, KEYS listing policy, sale ledger
Solana NFT Gates — Metaplex Core + GateEscrow + stake-to-activate
Staking
Owner Project Lab — /my-orders, order_lab room, /admin/crm/orders
Ops checklist: Payment integration

5. Product features

Realtime & communication

Tunnel Protocol
Messaging — Conversation.type vs metadata.kind; inbox hide for tool chats
Ring Tasks — task message type, /tasks tree, credit escrow, convert → request opportunity
WebRTC Calls & STUNner
Peer Games — /games, game_request, Tunnel+DB SSOT (tic-tac-toe, chess, checkers); P1 expiry/ACL/FCM/DataChannel hints
Push Notifications (FCM)
Notifications
Email AI-CRM — UI /admin/crm/*; APIs /api/admin/email/*
Ring Mailer & RingdomX — own SMTP / Ethereal; calculator mail add-on
Owner Project Lab — buyer My Projects + shared order_lab + CRM order desk

Identity, trust, content

Authentication — Auth.js providers including Telegram OIDC + Mini App initData
Security
Admin console — admin-nav-config SSOT, CrmAdminShell tabs, Security/Matcher tabs
Admin Wiki — Postgres Markdown vault, [[wikilinks]], ring-wiki-* MCP
Manage via Telegram — admin bot RBAC + webhook (not member Login / Mini App)
Entities
Opportunities
AI Matcher
News — TipTap NewsEditor, pending-revision APIs, sanitizeNewsHtml
Member Blog
Public Profile
Profile Account Widgets — /profile Organization Davinci-droplist, Position/Skills tag clouds, My CV FsModal
File Cabinet — member-gated /file-cabinet, subscriber+ /profile/shared, gallery, public /{username}/img
Username Reservation
Scientific Editor — publications TipTap JSON + versions (not news)
Locale System
Doc System

Media, UX, ERP

VideoConductor
MediaConductor — Audible radio-host TTS + Agent NODUS (docs_article_enrichment, /llms.txt, /nodus.json) + Visual walkthrough
Generative Gallery — features/generative-media/, Ghost-write + ImageConductor, WebP, hidden genmedia: chats
Mobile Experience
Performance
ERP — Inventory · Vendor management · Commissions

6. Deploy & env

Deployment → · Configuration →

Environment — full env.local.template reference
Public vars · Secrets — Order Lab ownership taxonomy
WalletConnect Project ID · Supported services
NODUS wiki · Playbook
Self-Hosted
Docker
Vercel — vercel.json crons[] must list every ProcessConductor cronPath; Bearer CRON_SECRET
Monitoring
Performance
Backup

7a. Engineering core

Development →

Local Setup
Code Structure
Code Style
Best Practices
Testing
Debugging
Performance
Workflow
Contributing
Deployment
Docs Components
Community Tooling
Ring MCP
Whitelabel Navigation — closed Lucide map, pack primary-nav.ts, overlay remap-only
OSS vs Enterprise

7b. Generative media + MCP

8. Customize & examples

Customization → · Examples →

Customization: quick-start, guide, vertical presets, ringization playbook, localization (Layer1 → pack.json → overlay), database-selection, token-economics, payment-integration, AI, branding, features, themes, components
Examples: quick-start, basic-setup, authentication, email-ai-crm, api-integration, api-examples, web3-integration, white-label, custom-branding, apple-signin, integrations, real-world, advanced-features
Ethereum Wallets
Token Launch Jurisdictions
Wallet Security Tips

Reference

Roadmap · Docs hub · For Founders · Vendor Guide

Developers optimize for architecture, performance, and correctness. Use the sidebar to flip to Founder for operator journey hubs.

Updated Sep 9, 20265 min listen

// NOTE: Info-source reference only — NOT a sidebar navigation item. // See docs/en/for-founders.mdx for the full policy note. // Sidebar section order = AUDIENCE_CURATED_DOCS.developer key order (system layers).

For Developers

Curated index for developers, integrators, and engineers. Hubs follow system layers (Architecture → API → Features → Deploy → Development/MCP). The sidebar Developer tab mirrors this via lib/docs/audience-curated-docs.ts. Founders see Features / Examples / Customization / Web3 first — flip the sidebar tab anytime.

Flip Founder / Developer in the docs sidebar anytime. Operator journey hubs live on For Founders.

1. Bootstrap

Getting Started →

2. System architecture

Architecture → · Backend →

Backend Modes and Databases
Data Model
Data Validation
Authentication
Security
Real-Time
Discovery Mutation Sync
Proxy and i18n
PaymentConductor
WalletConductor — facade adapters, rates, /api/wallet/*
Refcodes
News Kingdom
Email AI-CRM
k3s + Postgres + FCM
Firebase — Hosting rewrites + Cloud Scheduler for ProcessConductor /api/cron/* (schedule catalog = vercel.json)

3. API contracts

API Reference → — visual RingApiTree widget + ~244 App Router /api/* handlers (truth as of 2026-07-10).

Authentication
Entities
Opportunities
Messaging — verified /api/conversations types (direct|entity|opportunity|product|group); no channel
Notifications
Wallet
Store — PaymentConductor store_order (no fabricated cart REST)
Admin — includes user Payments tab
Email AI-CRM
Ring MCP — /api/mcp/v1/*
Tunnel protocol — /api/tunnel/*

4. Payments cluster (ordered)

Features →

PaymentConductor
Ring Oracle — server-only rate facade, FX cron, conversion API, SSR hydrate, and checkout presentment
WayForPay Integration
SubscriptionConductor — multi-provider ledger including telegram_stars
Payments overview
Public Pools & DAO Jars — public_pool_contribution, desk FX, builder payout, escrow gate
Store
Wallet
WalletConductor — custodial native + credit orchestration (top-up, desk, spend, NFT buy)
Credit Rewards — credit.rewards.enabled, enqueueRewardCreditAddEvent, UserProgressWidget
Refcodes
Affiliates
NFT Marketplace — ledger-dev RING settlement, KEYS listing policy, sale ledger
Solana NFT Gates — Metaplex Core + GateEscrow + stake-to-activate
Staking
Owner Project Lab — /my-orders, order_lab room, /admin/crm/orders
Ops checklist: Payment integration

5. Product features

Realtime & communication

Tunnel Protocol
Messaging — Conversation.type vs metadata.kind; inbox hide for tool chats
Ring Tasks — task message type, /tasks tree, credit escrow, convert → request opportunity
WebRTC Calls & STUNner
Peer Games — /games, game_request, Tunnel+DB SSOT (tic-tac-toe, chess, checkers); P1 expiry/ACL/FCM/DataChannel hints
Push Notifications (FCM)
Notifications
Email AI-CRM — UI /admin/crm/*; APIs /api/admin/email/*
Ring Mailer & RingdomX — own SMTP / Ethereal; calculator mail add-on
Owner Project Lab — buyer My Projects + shared order_lab + CRM order desk

Identity, trust, content

Authentication — Auth.js providers including Telegram OIDC + Mini App initData
Security
Admin console — admin-nav-config SSOT, CrmAdminShell tabs, Security/Matcher tabs
Admin Wiki — Postgres Markdown vault, [[wikilinks]], ring-wiki-* MCP
Manage via Telegram — admin bot RBAC + webhook (not member Login / Mini App)
Entities
Opportunities
AI Matcher
News — TipTap NewsEditor, pending-revision APIs, sanitizeNewsHtml
Member Blog
Public Profile
Profile Account Widgets — /profile Organization Davinci-droplist, Position/Skills tag clouds, My CV FsModal
File Cabinet — member-gated /file-cabinet, subscriber+ /profile/shared, gallery, public /{username}/img
Username Reservation
Scientific Editor — publications TipTap JSON + versions (not news)
Locale System
Doc System

Media, UX, ERP

VideoConductor
MediaConductor — Audible radio-host TTS + Agent NODUS (docs_article_enrichment, /llms.txt, /nodus.json) + Visual walkthrough
Generative Gallery — features/generative-media/, Ghost-write + ImageConductor, WebP, hidden genmedia: chats
Mobile Experience
Performance
ERP — Inventory · Vendor management · Commissions

6. Deploy & env

Deployment → · Configuration →

Environment — full env.local.template reference
Public vars · Secrets — Order Lab ownership taxonomy
WalletConnect Project ID · Supported services
NODUS wiki · Playbook
Self-Hosted
Docker
Vercel — vercel.json crons[] must list every ProcessConductor cronPath; Bearer CRON_SECRET
Monitoring
Performance
Backup

7a. Engineering core

Development →

Local Setup
Code Structure
Code Style
Best Practices
Testing
Debugging
Performance
Workflow
Contributing
Deployment
Docs Components
Community Tooling
Ring MCP
Whitelabel Navigation — closed Lucide map, pack primary-nav.ts, overlay remap-only
OSS vs Enterprise

7b. Generative media + MCP

8. Customize & examples

Customization → · Examples →

Customization: quick-start, guide, vertical presets, ringization playbook, localization (Layer1 → pack.json → overlay), database-selection, token-economics, payment-integration, AI, branding, features, themes, components
Examples: quick-start, basic-setup, authentication, email-ai-crm, api-integration, api-examples, web3-integration, white-label, custom-branding, apple-signin, integrations, real-world, advanced-features
Ethereum Wallets
Token Launch Jurisdictions
Wallet Security Tips

Reference

Roadmap · Docs hub · For Founders · Vendor Guide

Developers optimize for architecture, performance, and correctness. Use the sidebar to flip to Founder for operator journey hubs.

Updated Sep 9, 20265 min listen