Завантаження документації...
Підготовка контенту платформи Ring
Підготовка контенту платформи Ring
Підготовка контенту платформи Ring
Підготовка контенту платформи Ring
navigation.docs_sidebar.audience.founderHint
navigation.docs_sidebar.audience.founderHint
navigation.docs_sidebar.audience.founderHint
Документация 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 |
| Code | Конфиг с Shiki | Server (async) |
| MindMap | Деревья понятий — осторожно на хабах |
Огороженные блоки ```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 |
| Code | Конфиг с Shiki | Server (async) |
| MindMap | Деревья понятий — осторожно на хабах |
Огороженные блоки ```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 |
| Code | Конфиг с Shiki | Server (async) |
| MindMap | Деревья понятий — осторожно на хабах |
Огороженные блоки ```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.
| Client |
| Timeline | История релизов / миграций | Client |
| RingAISynapseFlow | Маркетинг / AI-демо — тяжёлый бандл | Client |
| CodeSandbox | Живые примеры в /examples | Client |
| Math / MathBlock | Научный редактор, токеномика | Client |
| Client |
| Timeline | История релизов / миграций | Client |
| RingAISynapseFlow | Маркетинг / AI-демо — тяжёлый бандл | Client |
| CodeSandbox | Живые примеры в /examples | Client |
| Math / MathBlock | Научный редактор, токеномика | Client |
| Client |
| Timeline | История релизов / миграций | Client |
| RingAISynapseFlow | Маркетинг / AI-демо — тяжёлый бандл | Client |
| CodeSandbox | Живые примеры в /examples | Client |
| Math / MathBlock | Научный редактор, токеномика | Client |