Loading documentation...
Preparing Ring content
Concepts, value, and typical clone scenarios — less code.
Concepts, value, and typical clone scenarios — less code.
Preparing Ring content
Preparing Ring content
Preparing Ring content
Ring-docs is the MDX component layer behind every page at /docs/*. Authors write .mdx under docs/{locale}/; the app renders them with next-mdx-remote/rsc and the shared map in components/docs/mdx-docs-shared.tsx.
Technical writers, feature owners, and contributors who publish Ring Platform documentation with consistent visuals — without importing third-party doc UI kits.
| Piece | Path | Role |
|---|---|---|
| Content | docs/{locale}/**/*.mdx | Frontmatter + MDX body |
| Resolver | lib/docs/docs-path.ts | Slug → file; buildDocsHref() |
| Components | components/docs/mdx-docs-shared.tsx | Registers all JSX tags below |
| Highlighting | Shiki (nord / tokyo-night) | Server <Code> blocks |
New diagram types and sandbox presets are added incrementally. If a component is marked development in product docs, use this callout so readers know APIs may change before the next release.
Highlighted prose for executives, warnings, tips, and product status. Seven types — unknown types fall back to info.
type | Use when |
|---|---|
info | Context, paths, policy |
tip | Best practice, positioning |
success | Validation passed, outcome summary |
warning | Security, irreversible ops |
error | Broken config, hard failure |
development | Feature in flux, preview APIs |
financing | Grants, RING treasury, vendor funding |
Canonical EN paths live under docs/en/. UK/RU summaries follow scripts/LOCALE-GAPS.md unless a page is fully translated.
Hub pages work best with one architecture diagram and Cards linking every child in meta.json.
Your doc page renders when npm run dev serves /docs/features/doc-system without MDX parse errors.
Never commit production secrets (WAYFORPAY_SECRET_KEY, AUTH_SECRET) into MDX or code blocks.
Missing Callout type values crash render — stick to the seven types above or omit type (defaults to info).
Scientific editor collaboration CRDT and multi-replica tunnel hubs are evolving — check feature flags and implementation logs before shipping dependent docs.
Ring-powered marketplaces can surface vendor growth and cooperative funding programs — link opportunities and wallet docs when describing token or grant mechanics for sellers.
Numbered walkthroughs for install, onboarding, and checklists.
Leave blank lines before <Steps>, before each <Step>, after each </Step>, and after </Steps> — otherwise MDX parsing fails.
Add the page slug to docs/en/{section}/meta.json → pages[].
Author content with components from this page.
Verify at http://localhost:3000/docs/features/your-page.
Split audiences on the same URL — developers vs operators, or Do vs Avoid.
value on each <Tab> (not title)items={['A','B']} on <Tabs> for trigger orderHub navigation — every child page in a section meta.json should have a card on that section's index.mdx.
Seller-first marketplace onboarding on ring-platform.org.
Payments, trust tiers, and catalog architecture.
Authoring rules, hub checklist, and contributor workflow.
Client-rendered diagrams. Pass diagram source as a template literal child:
Fenced blocks also work — rehype converts ```mermaid to <Mermaid> automatically.
Mermaid mindmap syntax via the MindMap alias — use once per hub, not on every page.
Server-rendered Shiki highlighting. Use language and optional title:
Inline code uses single backticks: docsMdxComponents, resolveDocFilePath().
Client-only (react-chrono). Ideal for roadmaps and migration history.
Layout cards inside MDX — distinct from doc navigation Card. Use for grouped settings or API panels:
UiCard* components mirror shadcn Card for dense reference blocks.
Prefer Callout for alerts and Card for navigation links.
KaTeX for tokenomics and scientific editor docs.
Inline: commission rate
(example).Display:
| Component | When to use | Embed on dense reference pages? |
|---|---|---|
| CodeSandbox | /examples — live Sandpack previews | Sparingly |
| RingAISynapseFlow | AI matching marketing visuals | No — large bundle |
Image (via img) | Screenshots with border radius | Yes |
Documentation that explains marketplace revenue, affiliate programs, or treasury participation should cross-link Wallet and Affiliate enablement using the financing callout where funding mechanics matter.
These elements need no JSX — remark-gfm styles them via the MDX map:
| Element | Styled behavior |
|---|---|
Headings ## | Scroll margin, border on h2 |
| Tables | Bordered rows, hover |
| Lists | Disc / decimal with spacing |
| Blockquote | Primary left border |
| Links | Primary color underline |
| Component | Import map key | Client? |
|---|---|---|
| Callout | Callout | Yes |
| Steps / Step | Steps, Step | Yes |
| Tabs / Tab | Tabs, Tab | Yes |
| Cards / Card | Cards, Card | Server-friendly |
| Mermaid | Mermaid | Yes |
| MindMap | MindMap | Yes |
| Code |
Ring-docs is the MDX component layer behind every page at /docs/*. Authors write .mdx under docs/{locale}/; the app renders them with next-mdx-remote/rsc and the shared map in components/docs/mdx-docs-shared.tsx.
Technical writers, feature owners, and contributors who publish Ring Platform documentation with consistent visuals — without importing third-party doc UI kits.
| Piece | Path | Role |
|---|---|---|
| Content | docs/{locale}/**/*.mdx | Frontmatter + MDX body |
| Resolver | lib/docs/docs-path.ts | Slug → file; buildDocsHref() |
| Components | components/docs/mdx-docs-shared.tsx | Registers all JSX tags below |
| Highlighting | Shiki (nord / tokyo-night) | Server <Code> blocks |
New diagram types and sandbox presets are added incrementally. If a component is marked development in product docs, use this callout so readers know APIs may change before the next release.
Highlighted prose for executives, warnings, tips, and product status. Seven types — unknown types fall back to info.
type | Use when |
|---|---|
info | Context, paths, policy |
tip | Best practice, positioning |
success | Validation passed, outcome summary |
warning | Security, irreversible ops |
error | Broken config, hard failure |
development | Feature in flux, preview APIs |
financing | Grants, RING treasury, vendor funding |
Canonical EN paths live under docs/en/. UK/RU summaries follow scripts/LOCALE-GAPS.md unless a page is fully translated.
Hub pages work best with one architecture diagram and Cards linking every child in meta.json.
Your doc page renders when npm run dev serves /docs/features/doc-system without MDX parse errors.
Never commit production secrets (WAYFORPAY_SECRET_KEY, AUTH_SECRET) into MDX or code blocks.
Missing Callout type values crash render — stick to the seven types above or omit type (defaults to info).
Scientific editor collaboration CRDT and multi-replica tunnel hubs are evolving — check feature flags and implementation logs before shipping dependent docs.
Ring-powered marketplaces can surface vendor growth and cooperative funding programs — link opportunities and wallet docs when describing token or grant mechanics for sellers.
Numbered walkthroughs for install, onboarding, and checklists.
Leave blank lines before <Steps>, before each <Step>, after each </Step>, and after </Steps> — otherwise MDX parsing fails.
Add the page slug to docs/en/{section}/meta.json → pages[].
Author content with components from this page.
Verify at http://localhost:3000/docs/features/your-page.
Split audiences on the same URL — developers vs operators, or Do vs Avoid.
value on each <Tab> (not title)items={['A','B']} on <Tabs> for trigger orderHub navigation — every child page in a section meta.json should have a card on that section's index.mdx.
Seller-first marketplace onboarding on ring-platform.org.
Payments, trust tiers, and catalog architecture.
Authoring rules, hub checklist, and contributor workflow.
Client-rendered diagrams. Pass diagram source as a template literal child:
Fenced blocks also work — rehype converts ```mermaid to <Mermaid> automatically.
Mermaid mindmap syntax via the MindMap alias — use once per hub, not on every page.
Server-rendered Shiki highlighting. Use language and optional title:
Inline code uses single backticks: docsMdxComponents, resolveDocFilePath().
Client-only (react-chrono). Ideal for roadmaps and migration history.
Layout cards inside MDX — distinct from doc navigation Card. Use for grouped settings or API panels:
UiCard* components mirror shadcn Card for dense reference blocks.
Prefer Callout for alerts and Card for navigation links.
KaTeX for tokenomics and scientific editor docs.
Inline: commission rate
(example).Display:
| Component | When to use | Embed on dense reference pages? |
|---|---|---|
| CodeSandbox | /examples — live Sandpack previews | Sparingly |
| RingAISynapseFlow | AI matching marketing visuals | No — large bundle |
Image (via img) | Screenshots with border radius | Yes |
Documentation that explains marketplace revenue, affiliate programs, or treasury participation should cross-link Wallet and Affiliate enablement using the financing callout where funding mechanics matter.
These elements need no JSX — remark-gfm styles them via the MDX map:
| Element | Styled behavior |
|---|---|
Headings ## | Scroll margin, border on h2 |
| Tables | Bordered rows, hover |
| Lists | Disc / decimal with spacing |
| Blockquote | Primary left border |
| Links | Primary color underline |
| Component | Import map key | Client? |
|---|---|---|
| Callout | Callout | Yes |
| Steps / Step | Steps, Step | Yes |
| Tabs / Tab | Tabs, Tab | Yes |
| Cards / Card | Cards, Card | Server-friendly |
| Mermaid | Mermaid | Yes |
| MindMap | MindMap | Yes |
| Code |
Ring-docs is the MDX component layer behind every page at /docs/*. Authors write .mdx under docs/{locale}/; the app renders them with next-mdx-remote/rsc and the shared map in components/docs/mdx-docs-shared.tsx.
Technical writers, feature owners, and contributors who publish Ring Platform documentation with consistent visuals — without importing third-party doc UI kits.
| Piece | Path | Role |
|---|---|---|
| Content | docs/{locale}/**/*.mdx | Frontmatter + MDX body |
| Resolver | lib/docs/docs-path.ts | Slug → file; buildDocsHref() |
| Components | components/docs/mdx-docs-shared.tsx | Registers all JSX tags below |
| Highlighting | Shiki (nord / tokyo-night) | Server <Code> blocks |
New diagram types and sandbox presets are added incrementally. If a component is marked development in product docs, use this callout so readers know APIs may change before the next release.
Highlighted prose for executives, warnings, tips, and product status. Seven types — unknown types fall back to info.
type | Use when |
|---|---|
info | Context, paths, policy |
tip | Best practice, positioning |
success | Validation passed, outcome summary |
warning | Security, irreversible ops |
error | Broken config, hard failure |
development | Feature in flux, preview APIs |
financing | Grants, RING treasury, vendor funding |
Canonical EN paths live under docs/en/. UK/RU summaries follow scripts/LOCALE-GAPS.md unless a page is fully translated.
Hub pages work best with one architecture diagram and Cards linking every child in meta.json.
Your doc page renders when npm run dev serves /docs/features/doc-system without MDX parse errors.
Never commit production secrets (WAYFORPAY_SECRET_KEY, AUTH_SECRET) into MDX or code blocks.
Missing Callout type values crash render — stick to the seven types above or omit type (defaults to info).
Scientific editor collaboration CRDT and multi-replica tunnel hubs are evolving — check feature flags and implementation logs before shipping dependent docs.
Ring-powered marketplaces can surface vendor growth and cooperative funding programs — link opportunities and wallet docs when describing token or grant mechanics for sellers.
Numbered walkthroughs for install, onboarding, and checklists.
Leave blank lines before <Steps>, before each <Step>, after each </Step>, and after </Steps> — otherwise MDX parsing fails.
Add the page slug to docs/en/{section}/meta.json → pages[].
Author content with components from this page.
Verify at http://localhost:3000/docs/features/your-page.
Split audiences on the same URL — developers vs operators, or Do vs Avoid.
value on each <Tab> (not title)items={['A','B']} on <Tabs> for trigger orderHub navigation — every child page in a section meta.json should have a card on that section's index.mdx.
Seller-first marketplace onboarding on ring-platform.org.
Payments, trust tiers, and catalog architecture.
Authoring rules, hub checklist, and contributor workflow.
Client-rendered diagrams. Pass diagram source as a template literal child:
Fenced blocks also work — rehype converts ```mermaid to <Mermaid> automatically.
Mermaid mindmap syntax via the MindMap alias — use once per hub, not on every page.
Server-rendered Shiki highlighting. Use language and optional title:
Inline code uses single backticks: docsMdxComponents, resolveDocFilePath().
Client-only (react-chrono). Ideal for roadmaps and migration history.
Layout cards inside MDX — distinct from doc navigation Card. Use for grouped settings or API panels:
UiCard* components mirror shadcn Card for dense reference blocks.
Prefer Callout for alerts and Card for navigation links.
KaTeX for tokenomics and scientific editor docs.
Inline: commission rate
(example).Display:
| Component | When to use | Embed on dense reference pages? |
|---|---|---|
| CodeSandbox | /examples — live Sandpack previews | Sparingly |
| RingAISynapseFlow | AI matching marketing visuals | No — large bundle |
Image (via img) | Screenshots with border radius | Yes |
Documentation that explains marketplace revenue, affiliate programs, or treasury participation should cross-link Wallet and Affiliate enablement using the financing callout where funding mechanics matter.
These elements need no JSX — remark-gfm styles them via the MDX map:
| Element | Styled behavior |
|---|---|
Headings ## | Scroll margin, border on h2 |
| Tables | Bordered rows, hover |
| Lists | Disc / decimal with spacing |
| Blockquote | Primary left border |
| Links | Primary color underline |
| Component | Import map key | Client? |
|---|---|---|
| Callout | Callout | Yes |
| Steps / Step | Steps, Step | Yes |
| Tabs / Tab | Tabs, Tab | Yes |
| Cards / Card | Cards, Card | Server-friendly |
| Mermaid | Mermaid | Yes |
| MindMap | MindMap | Yes |
| Code |
Code |
| Server async |
| Timeline | Timeline | Yes |
| Math / MathBlock | Math, MathBlock | Yes |
| UiCard* | UiCard, … | Server-friendly |
| CodeSandbox | CodeSandbox | Yes |
| RingAISynapseFlow | RingAISynapseFlow | Yes |
<Callout type="financing" title="Financing opportunity">
Describe grants, revenue share, or treasury programs here.
</Callout>Code |
| Server async |
| Timeline | Timeline | Yes |
| Math / MathBlock | Math, MathBlock | Yes |
| UiCard* | UiCard, … | Server-friendly |
| CodeSandbox | CodeSandbox | Yes |
| RingAISynapseFlow | RingAISynapseFlow | Yes |
<Callout type="financing" title="Financing opportunity">
Describe grants, revenue share, or treasury programs here.
</Callout>Code |
| Server async |
| Timeline | Timeline | Yes |
| Math / MathBlock | Math, MathBlock | Yes |
| UiCard* | UiCard, … | Server-friendly |
| CodeSandbox | CodeSandbox | Yes |
| RingAISynapseFlow | RingAISynapseFlow | Yes |
<Callout type="financing" title="Financing opportunity">
Describe grants, revenue share, or treasury programs here.
</Callout>