Loading documentation...
Preparing Ring Platform content
Концепції, цінність і типові сценарії
Концепції, цінність і типові сценарії
Preparing Ring Platform content
Preparing Ring Platform content
Preparing Ring Platform content
Документація Ring — це MDX-файли, які рендерить next-mdx-remote/rsc зі спільною мапою компонентів у components/docs/mdx-docs-shared.tsx. Використовуйте ці блоки для сторінок, зрозумілих розробникам (шляхи, код) та керівникам (результат, одна діаграма, чітка навігація).
Канонічні шляхи: контент у docs/{locale}/{section}/{page}.mdx. Публічні URL: /docs/... (префікс локалі за next-intl as-needed).
| Етап | Розташування | Роль |
|---|---|---|
| Контент | docs/{locale}/ | title, description, тіло MDX |
| Resolver | lib/docs/docs-path.ts | Slug → docs/{locale}/**; hub (foo/index.mdx) і leaf (foo.mdx); buildDocsHref(), scanDocsStaticParams() |
| Компоненти | components/docs/mdx-docs-shared.tsx | Реєстрація JSX-тегів |
| Підсвітка | Shiki (nord / tokyo-night) | Серверний <Code> |
| Компонент | Найкраще для | Client / server |
|---|---|---|
| Callout | Резюме для керівників, попередження (DB_BACKEND_MODE, legal) | Client |
| Mermaid | Одна системна карта + одна sequence на хаб (без розростання) | Client |
| Tabs / Tab | Розробник vs Оператор (або CEO) на одній сторінці | Client |
| Cards / Card | Навігація хаба до дочірніх статей | Server-friendly |
| Steps / Step | Інсталяція та деплой покроково | Server-friendly |
Огороджені блоки ```typescript та ```mermaid перетворюються на <Code> та <Mermaid> через rehype.
Типи: info | warning | error | success. Опційно title.
Починайте хаби з одного абзацу результату для операторів і CEO, далі таблиця та одна системна діаграма.
На хабах — одна архітектурна карта та одна sequence. Решта — на дочірніх сторінках.
lib/database/DatabaseService.ts)Обов’язковий патерн для хабів секцій (index.mdx). Кожна картка — дочірня сторінка з meta.json.
Системна карта, Tabs, посилання на всі дочірні статті
Канонічний довідник DB_BACKEND_MODE
Href: /docs/... без сегмента library.
Потрібні порожні рядки перед <Steps>, перед кожним <Step>, після </Step> і після </Steps>.
Встановіть залежності:
Додайте сторінку в meta.json секції та синхронізуйте UK/RU за LOCALE-GAPS.md.
Перевірте http://localhost:3000/docs/{section}/{page}.
Інлайн-код: DatabaseService, auth().
| Компонент | Коли |
|---|---|
| Timeline | Міграції, roadmap (react-chrono, client-only) |
| RingAISynapseFlow | Лише маркетинг — не на довідникових сторінках |
| CodeSandbox | Розділ /examples, Sandpack |
| Math / MathBlock | Формули в наукових / tokenomics статтях |
Callout для керівників — кому сторінка і дефолт деплою.
Таблиця можливостей — дані, auth, платежі, realtime.
Одна системна Mermaid — логічні шари.
Tabs — Розробники vs Оператори.
Cards — усі pages[] з meta.json, крім index.
| Правило | Чому |
|---|---|
| EN канонічний, UK/RU за LOCALE-GAPS | Без розбіжностей у env/API |
Frontmatter title + description | SEO і сайдбар |
Без fumadocs-ui | Лише components/docs/ |
npm run dev після нового MDX | Ловити помилки Steps/Mermaid |
ring-docs-specialist.nodus.jsonПісля змін оновлюйте scripts/LOCALE-GAPS.md.
Документація Ring — це MDX-файли, які рендерить next-mdx-remote/rsc зі спільною мапою компонентів у components/docs/mdx-docs-shared.tsx. Використовуйте ці блоки для сторінок, зрозумілих розробникам (шляхи, код) та керівникам (результат, одна діаграма, чітка навігація).
Канонічні шляхи: контент у docs/{locale}/{section}/{page}.mdx. Публічні URL: /docs/... (префікс локалі за next-intl as-needed).
| Етап | Розташування | Роль |
|---|---|---|
| Контент | docs/{locale}/ | title, description, тіло MDX |
| Resolver | lib/docs/docs-path.ts | Slug → docs/{locale}/**; hub (foo/index.mdx) і leaf (foo.mdx); buildDocsHref(), scanDocsStaticParams() |
| Компоненти | components/docs/mdx-docs-shared.tsx | Реєстрація JSX-тегів |
| Підсвітка | Shiki (nord / tokyo-night) | Серверний <Code> |
| Компонент | Найкраще для | Client / server |
|---|---|---|
| Callout | Резюме для керівників, попередження (DB_BACKEND_MODE, legal) | Client |
| Mermaid | Одна системна карта + одна sequence на хаб (без розростання) | Client |
| Tabs / Tab | Розробник vs Оператор (або CEO) на одній сторінці | Client |
| Cards / Card | Навігація хаба до дочірніх статей | Server-friendly |
| Steps / Step | Інсталяція та деплой покроково | Server-friendly |
Огороджені блоки ```typescript та ```mermaid перетворюються на <Code> та <Mermaid> через rehype.
Типи: info | warning | error | success. Опційно title.
Починайте хаби з одного абзацу результату для операторів і CEO, далі таблиця та одна системна діаграма.
На хабах — одна архітектурна карта та одна sequence. Решта — на дочірніх сторінках.
lib/database/DatabaseService.ts)Обов’язковий патерн для хабів секцій (index.mdx). Кожна картка — дочірня сторінка з meta.json.
Системна карта, Tabs, посилання на всі дочірні статті
Канонічний довідник DB_BACKEND_MODE
Href: /docs/... без сегмента library.
Потрібні порожні рядки перед <Steps>, перед кожним <Step>, після </Step> і після </Steps>.
Встановіть залежності:
Додайте сторінку в meta.json секції та синхронізуйте UK/RU за LOCALE-GAPS.md.
Перевірте http://localhost:3000/docs/{section}/{page}.
Інлайн-код: DatabaseService, auth().
| Компонент | Коли |
|---|---|
| Timeline | Міграції, roadmap (react-chrono, client-only) |
| RingAISynapseFlow | Лише маркетинг — не на довідникових сторінках |
| CodeSandbox | Розділ /examples, Sandpack |
| Math / MathBlock | Формули в наукових / tokenomics статтях |
Callout для керівників — кому сторінка і дефолт деплою.
Таблиця можливостей — дані, auth, платежі, realtime.
Одна системна Mermaid — логічні шари.
Tabs — Розробники vs Оператори.
Cards — усі pages[] з meta.json, крім index.
| Правило | Чому |
|---|---|
| EN канонічний, UK/RU за LOCALE-GAPS | Без розбіжностей у env/API |
Frontmatter title + description | SEO і сайдбар |
Без fumadocs-ui | Лише components/docs/ |
npm run dev після нового MDX | Ловити помилки Steps/Mermaid |
ring-docs-specialist.nodus.jsonПісля змін оновлюйте scripts/LOCALE-GAPS.md.
Документація Ring — це MDX-файли, які рендерить next-mdx-remote/rsc зі спільною мапою компонентів у components/docs/mdx-docs-shared.tsx. Використовуйте ці блоки для сторінок, зрозумілих розробникам (шляхи, код) та керівникам (результат, одна діаграма, чітка навігація).
Канонічні шляхи: контент у docs/{locale}/{section}/{page}.mdx. Публічні URL: /docs/... (префікс локалі за next-intl as-needed).
| Етап | Розташування | Роль |
|---|---|---|
| Контент | docs/{locale}/ | title, description, тіло MDX |
| Resolver | lib/docs/docs-path.ts | Slug → docs/{locale}/**; hub (foo/index.mdx) і leaf (foo.mdx); buildDocsHref(), scanDocsStaticParams() |
| Компоненти | components/docs/mdx-docs-shared.tsx | Реєстрація JSX-тегів |
| Підсвітка | Shiki (nord / tokyo-night) | Серверний <Code> |
| Компонент | Найкраще для | Client / server |
|---|---|---|
| Callout | Резюме для керівників, попередження (DB_BACKEND_MODE, legal) | Client |
| Mermaid | Одна системна карта + одна sequence на хаб (без розростання) | Client |
| Tabs / Tab | Розробник vs Оператор (або CEO) на одній сторінці | Client |
| Cards / Card | Навігація хаба до дочірніх статей | Server-friendly |
| Steps / Step | Інсталяція та деплой покроково | Server-friendly |
Огороджені блоки ```typescript та ```mermaid перетворюються на <Code> та <Mermaid> через rehype.
Типи: info | warning | error | success. Опційно title.
Починайте хаби з одного абзацу результату для операторів і CEO, далі таблиця та одна системна діаграма.
На хабах — одна архітектурна карта та одна sequence. Решта — на дочірніх сторінках.
lib/database/DatabaseService.ts)Обов’язковий патерн для хабів секцій (index.mdx). Кожна картка — дочірня сторінка з meta.json.
Системна карта, Tabs, посилання на всі дочірні статті
Канонічний довідник DB_BACKEND_MODE
Href: /docs/... без сегмента library.
Потрібні порожні рядки перед <Steps>, перед кожним <Step>, після </Step> і після </Steps>.
Встановіть залежності:
Додайте сторінку в meta.json секції та синхронізуйте UK/RU за LOCALE-GAPS.md.
Перевірте http://localhost:3000/docs/{section}/{page}.
Інлайн-код: DatabaseService, auth().
| Компонент | Коли |
|---|---|
| Timeline | Міграції, roadmap (react-chrono, client-only) |
| RingAISynapseFlow | Лише маркетинг — не на довідникових сторінках |
| CodeSandbox | Розділ /examples, Sandpack |
| Math / MathBlock | Формули в наукових / tokenomics статтях |
Callout для керівників — кому сторінка і дефолт деплою.
Таблиця можливостей — дані, auth, платежі, realtime.
Одна системна Mermaid — логічні шари.
Tabs — Розробники vs Оператори.
Cards — усі pages[] з meta.json, крім index.
| Правило | Чому |
|---|---|
| EN канонічний, UK/RU за LOCALE-GAPS | Без розбіжностей у env/API |
Frontmatter title + description | SEO і сайдбар |
Без fumadocs-ui | Лише components/docs/ |
npm run dev після нового MDX | Ловити помилки Steps/Mermaid |
ring-docs-specialist.nodus.jsonПісля змін оновлюйте scripts/LOCALE-GAPS.md.
| Конфіг з Shiki |
| Server (async) |
| MindMap | Дерева понять — обережно на хабах | Client |
| Timeline | Історія релізів / міграцій | Client |
| RingAISynapseFlow | Маркетинг / AI-демо — важкий бандл | Client |
| CodeSandbox | Живі приклади в /examples | Client |
| Math / MathBlock | Науковий редактор, токеноміка | Client |
| Конфіг з Shiki |
| Server (async) |
| MindMap | Дерева понять — обережно на хабах | Client |
| Timeline | Історія релізів / міграцій | Client |
| RingAISynapseFlow | Маркетинг / AI-демо — важкий бандл | Client |
| CodeSandbox | Живі приклади в /examples | Client |
| Math / MathBlock | Науковий редактор, токеноміка | Client |
| Конфіг з Shiki |
| Server (async) |
| MindMap | Дерева понять — обережно на хабах | Client |
| Timeline | Історія релізів / міграцій | Client |
| RingAISynapseFlow | Маркетинг / AI-демо — важкий бандл | Client |
| CodeSandbox | Живі приклади в /examples | Client |
| Math / MathBlock | Науковий редактор, токеноміка | Client |