Loading documentation...
Preparing Ring content
Концепції, цінність і типові сценарії
Концепції, цінність і типові сценарії
Preparing Ring content
Preparing Ring content
Preparing Ring content
Ring-docs — це шар MDX-компонентів, на якому працює кожна сторінка за адресою /docs/*. Автори пишуть .mdx у docs/{locale}/; застосунок відображає їх за допомогою next-mdx-remote/rsc і спільної мапи в components/docs/mdx-docs-shared.tsx.
Технічні автори, власники функцій і контриб’ютори, які публікують документацію Ring Platform зі сталим візуальним стилем — без імпорту сторонніх наборів UI для документації.
| Частина | Шлях | Роль |
|---|---|---|
| Вміст | docs/{locale}/**/*.mdx | Frontmatter + тіло MDX |
| Resolver | lib/docs/docs-path.ts | Slug → файл; buildDocsHref() |
| Компоненти | components/docs/mdx-docs-shared.tsx | Реєструє всі JSX-теги нижче |
| Підсвічування | Shiki (nord / tokyo-night) | Серверні блоки <Code> |
Нові типи діаграм і пресети sandbox додаються поступово. Якщо в документації продукту компонент позначено як development, використовуйте цей callout, щоб читачі знали: API може змінитися до наступного релізу.
Виділений текст для керівників, попереджень, підказок і статусу продукту. Сім типів — невідомі типи повертаються до info.
type | Використовуйте, коли |
|---|---|
info | Контекст, шляхи, політика |
tip | Найкраща практика, позиціонування |
success | Перевірку пройдено, підсумок результату |
warning | Безпека, незворотні операції |
error | Зламана конфігурація, критична помилка |
development | Функція змінюється, API у попередньому перегляді |
financing | Гранти, скарбниця RING, фінансування від постачальників |
Канонічні шляхи EN розташовані в docs/en/. Підсумки UK/RU відповідають scripts/LOCALE-GAPS.md, якщо сторінку не перекладено повністю.
Для hub-сторінок найкраще працюють одна архітектурна діаграма та Cards із посиланнями на кожну дочірню сторінку в meta.json.
Нумеровані покрокові інструкції для встановлення, онбордингу та чеклістів.
Залишайте порожні рядки перед <Steps>, перед кожним <Step>, після </Step> і після </Steps> — інакше розбір MDX завершиться помилкою.
Додайте slug сторінки до docs/en/{section}/meta.json → pages[].
Створіть вміст за допомогою компонентів із цієї сторінки.
Перевірте за адресою http://localhost:3000/docs/features/your-page.
Розділяйте аудиторії за тією самою URL-адресою — розробники проти операторів або «Робіть» проти «Уникайте».
value у кожному <Tab> (не title)items={['A','B']} у <Tabs> визначає порядок тригерівНавігація hub-сторінки — кожна дочірня сторінка в meta.json розділу повинна мати картку на index.mdx цього розділу.
Онбординг продавців на ring-platform.org із фокусом на маркетплейс.
Платежі, рівні довіри та архітектура каталогу.
Правила створення, чекліст hub-сторінки та робочий процес контриб’ютора.
Діаграми, що відображаються на клієнті. Передавайте джерело діаграми як дочірній елемент template literal:
Блоки з огорожею також працюють — rehype автоматично перетворює Mermaid fence на <Mermaid>.
Синтаксис Mermaid mindmap через псевдонім MindMap — використовуйте один раз на hub-сторінку, а не на кожній сторінці.
Підсвічування Shiki, що виконується на сервері. Використовуйте language і необов’язковий title:
Для вбудованого коду використовуйте одиночні backticks: docsMdxComponents, resolveDocFilePath().
Лише клієнт (react-chrono). Ідеально для дорожніх карт та історії міграцій.
Картки макета всередині MDX — відмінні від навігаційного Card документації. Використовуйте їх для згрупованих налаштувань або панелей API:
Компоненти UiCard* відтворюють shadcn Card для щільних довідкових блоків.
Для сповіщень надавайте перевагу Callout, а для навігаційних посилань — Card.
KaTeX для документації з токеноміки та наукового редактора.
Вбудована формула: ставка комісії
(приклад).Відображення:
| Компонент | Коли використовувати | Додавати на щільні довідкові сторінки? |
|---|---|---|
| CodeSandbox | /examples — живі прев’ю Sandpack | Рідко |
| RingAISynapseFlow | Маркетингові візуали зіставлення ШІ | Ні — великий бандл |
Image (через img) | Скріншоти із заокругленням кутів | Так |
Документація про дохід маркетплейсу, партнерські програми або участь у скарбниці повинна містити посилання на Wallet і Affiliate enablement, використовуючи financing callout там, де важливі механізми фінансування.
Цим елементам не потрібен JSX — remark-gfm стилізує їх через мапу MDX:
| Елемент | Стилізація |
|---|---|
Заголовки ## | Відступ для прокручування, рамка для h2 |
| Таблиці | Рядки з рамками, ефект наведення |
| Списки | Маркери / десяткові числа з інтервалами |
| Blockquote | Основна ліва рамка |
| Посилання | Підкреслення основним кольором |
| Компонент | Ключ мапи імпорту | Клієнтський? |
|---|---|---|
| Callout | Callout | Так |
| Steps / Step | Steps, Step | Так |
| Tabs / Tab | Tabs, Tab | Так |
| Cards / Card | Cards, Card | Зручний для сервера |
| Mermaid | Mermaid | Так |
| MindMap | MindMap | Так |
| Code |
Ring-docs — це шар MDX-компонентів, на якому працює кожна сторінка за адресою /docs/*. Автори пишуть .mdx у docs/{locale}/; застосунок відображає їх за допомогою next-mdx-remote/rsc і спільної мапи в components/docs/mdx-docs-shared.tsx.
Технічні автори, власники функцій і контриб’ютори, які публікують документацію Ring Platform зі сталим візуальним стилем — без імпорту сторонніх наборів UI для документації.
| Частина | Шлях | Роль |
|---|---|---|
| Вміст | docs/{locale}/**/*.mdx | Frontmatter + тіло MDX |
| Resolver | lib/docs/docs-path.ts | Slug → файл; buildDocsHref() |
| Компоненти | components/docs/mdx-docs-shared.tsx | Реєструє всі JSX-теги нижче |
| Підсвічування | Shiki (nord / tokyo-night) | Серверні блоки <Code> |
Нові типи діаграм і пресети sandbox додаються поступово. Якщо в документації продукту компонент позначено як development, використовуйте цей callout, щоб читачі знали: API може змінитися до наступного релізу.
Виділений текст для керівників, попереджень, підказок і статусу продукту. Сім типів — невідомі типи повертаються до info.
type | Використовуйте, коли |
|---|---|
info | Контекст, шляхи, політика |
tip | Найкраща практика, позиціонування |
success | Перевірку пройдено, підсумок результату |
warning | Безпека, незворотні операції |
error | Зламана конфігурація, критична помилка |
development | Функція змінюється, API у попередньому перегляді |
financing | Гранти, скарбниця RING, фінансування від постачальників |
Канонічні шляхи EN розташовані в docs/en/. Підсумки UK/RU відповідають scripts/LOCALE-GAPS.md, якщо сторінку не перекладено повністю.
Для hub-сторінок найкраще працюють одна архітектурна діаграма та Cards із посиланнями на кожну дочірню сторінку в meta.json.
Нумеровані покрокові інструкції для встановлення, онбордингу та чеклістів.
Залишайте порожні рядки перед <Steps>, перед кожним <Step>, після </Step> і після </Steps> — інакше розбір MDX завершиться помилкою.
Додайте slug сторінки до docs/en/{section}/meta.json → pages[].
Створіть вміст за допомогою компонентів із цієї сторінки.
Перевірте за адресою http://localhost:3000/docs/features/your-page.
Розділяйте аудиторії за тією самою URL-адресою — розробники проти операторів або «Робіть» проти «Уникайте».
value у кожному <Tab> (не title)items={['A','B']} у <Tabs> визначає порядок тригерівНавігація hub-сторінки — кожна дочірня сторінка в meta.json розділу повинна мати картку на index.mdx цього розділу.
Онбординг продавців на ring-platform.org із фокусом на маркетплейс.
Платежі, рівні довіри та архітектура каталогу.
Правила створення, чекліст hub-сторінки та робочий процес контриб’ютора.
Діаграми, що відображаються на клієнті. Передавайте джерело діаграми як дочірній елемент template literal:
Блоки з огорожею також працюють — rehype автоматично перетворює Mermaid fence на <Mermaid>.
Синтаксис Mermaid mindmap через псевдонім MindMap — використовуйте один раз на hub-сторінку, а не на кожній сторінці.
Підсвічування Shiki, що виконується на сервері. Використовуйте language і необов’язковий title:
Для вбудованого коду використовуйте одиночні backticks: docsMdxComponents, resolveDocFilePath().
Лише клієнт (react-chrono). Ідеально для дорожніх карт та історії міграцій.
Картки макета всередині MDX — відмінні від навігаційного Card документації. Використовуйте їх для згрупованих налаштувань або панелей API:
Компоненти UiCard* відтворюють shadcn Card для щільних довідкових блоків.
Для сповіщень надавайте перевагу Callout, а для навігаційних посилань — Card.
KaTeX для документації з токеноміки та наукового редактора.
Вбудована формула: ставка комісії
(приклад).Відображення:
| Компонент | Коли використовувати | Додавати на щільні довідкові сторінки? |
|---|---|---|
| CodeSandbox | /examples — живі прев’ю Sandpack | Рідко |
| RingAISynapseFlow | Маркетингові візуали зіставлення ШІ | Ні — великий бандл |
Image (через img) | Скріншоти із заокругленням кутів | Так |
Документація про дохід маркетплейсу, партнерські програми або участь у скарбниці повинна містити посилання на Wallet і Affiliate enablement, використовуючи financing callout там, де важливі механізми фінансування.
Цим елементам не потрібен JSX — remark-gfm стилізує їх через мапу MDX:
| Елемент | Стилізація |
|---|---|
Заголовки ## | Відступ для прокручування, рамка для h2 |
| Таблиці | Рядки з рамками, ефект наведення |
| Списки | Маркери / десяткові числа з інтервалами |
| Blockquote | Основна ліва рамка |
| Посилання | Підкреслення основним кольором |
| Компонент | Ключ мапи імпорту | Клієнтський? |
|---|---|---|
| Callout | Callout | Так |
| Steps / Step | Steps, Step | Так |
| Tabs / Tab | Tabs, Tab | Так |
| Cards / Card | Cards, Card | Зручний для сервера |
| Mermaid | Mermaid | Так |
| MindMap | MindMap | Так |
| Code |
Ring-docs — це шар MDX-компонентів, на якому працює кожна сторінка за адресою /docs/*. Автори пишуть .mdx у docs/{locale}/; застосунок відображає їх за допомогою next-mdx-remote/rsc і спільної мапи в components/docs/mdx-docs-shared.tsx.
Технічні автори, власники функцій і контриб’ютори, які публікують документацію Ring Platform зі сталим візуальним стилем — без імпорту сторонніх наборів UI для документації.
| Частина | Шлях | Роль |
|---|---|---|
| Вміст | docs/{locale}/**/*.mdx | Frontmatter + тіло MDX |
| Resolver | lib/docs/docs-path.ts | Slug → файл; buildDocsHref() |
| Компоненти | components/docs/mdx-docs-shared.tsx | Реєструє всі JSX-теги нижче |
| Підсвічування | Shiki (nord / tokyo-night) | Серверні блоки <Code> |
Нові типи діаграм і пресети sandbox додаються поступово. Якщо в документації продукту компонент позначено як development, використовуйте цей callout, щоб читачі знали: API може змінитися до наступного релізу.
Виділений текст для керівників, попереджень, підказок і статусу продукту. Сім типів — невідомі типи повертаються до info.
type | Використовуйте, коли |
|---|---|
info | Контекст, шляхи, політика |
tip | Найкраща практика, позиціонування |
success | Перевірку пройдено, підсумок результату |
warning | Безпека, незворотні операції |
error | Зламана конфігурація, критична помилка |
development | Функція змінюється, API у попередньому перегляді |
financing | Гранти, скарбниця RING, фінансування від постачальників |
Канонічні шляхи EN розташовані в docs/en/. Підсумки UK/RU відповідають scripts/LOCALE-GAPS.md, якщо сторінку не перекладено повністю.
Для hub-сторінок найкраще працюють одна архітектурна діаграма та Cards із посиланнями на кожну дочірню сторінку в meta.json.
Нумеровані покрокові інструкції для встановлення, онбордингу та чеклістів.
Залишайте порожні рядки перед <Steps>, перед кожним <Step>, після </Step> і після </Steps> — інакше розбір MDX завершиться помилкою.
Додайте slug сторінки до docs/en/{section}/meta.json → pages[].
Створіть вміст за допомогою компонентів із цієї сторінки.
Перевірте за адресою http://localhost:3000/docs/features/your-page.
Розділяйте аудиторії за тією самою URL-адресою — розробники проти операторів або «Робіть» проти «Уникайте».
value у кожному <Tab> (не title)items={['A','B']} у <Tabs> визначає порядок тригерівНавігація hub-сторінки — кожна дочірня сторінка в meta.json розділу повинна мати картку на index.mdx цього розділу.
Онбординг продавців на ring-platform.org із фокусом на маркетплейс.
Платежі, рівні довіри та архітектура каталогу.
Правила створення, чекліст hub-сторінки та робочий процес контриб’ютора.
Діаграми, що відображаються на клієнті. Передавайте джерело діаграми як дочірній елемент template literal:
Блоки з огорожею також працюють — rehype автоматично перетворює Mermaid fence на <Mermaid>.
Синтаксис Mermaid mindmap через псевдонім MindMap — використовуйте один раз на hub-сторінку, а не на кожній сторінці.
Підсвічування Shiki, що виконується на сервері. Використовуйте language і необов’язковий title:
Для вбудованого коду використовуйте одиночні backticks: docsMdxComponents, resolveDocFilePath().
Лише клієнт (react-chrono). Ідеально для дорожніх карт та історії міграцій.
Картки макета всередині MDX — відмінні від навігаційного Card документації. Використовуйте їх для згрупованих налаштувань або панелей API:
Компоненти UiCard* відтворюють shadcn Card для щільних довідкових блоків.
Для сповіщень надавайте перевагу Callout, а для навігаційних посилань — Card.
KaTeX для документації з токеноміки та наукового редактора.
Вбудована формула: ставка комісії
(приклад).Відображення:
| Компонент | Коли використовувати | Додавати на щільні довідкові сторінки? |
|---|---|---|
| CodeSandbox | /examples — живі прев’ю Sandpack | Рідко |
| RingAISynapseFlow | Маркетингові візуали зіставлення ШІ | Ні — великий бандл |
Image (через img) | Скріншоти із заокругленням кутів | Так |
Документація про дохід маркетплейсу, партнерські програми або участь у скарбниці повинна містити посилання на Wallet і Affiliate enablement, використовуючи financing callout там, де важливі механізми фінансування.
Цим елементам не потрібен JSX — remark-gfm стилізує їх через мапу MDX:
| Елемент | Стилізація |
|---|---|
Заголовки ## | Відступ для прокручування, рамка для h2 |
| Таблиці | Рядки з рамками, ефект наведення |
| Списки | Маркери / десяткові числа з інтервалами |
| Blockquote | Основна ліва рамка |
| Посилання | Підкреслення основним кольором |
| Компонент | Ключ мапи імпорту | Клієнтський? |
|---|---|---|
| Callout | Callout | Так |
| Steps / Step | Steps, Step | Так |
| Tabs / Tab | Tabs, Tab | Так |
| Cards / Card | Cards, Card | Зручний для сервера |
| Mermaid | Mermaid | Так |
| MindMap | MindMap | Так |
| Code |
Code |
| Серверний async |
| Timeline | Timeline | Так |
| Math / MathBlock | Math, MathBlock | Так |
| UiCard* | UiCard, … | Зручний для сервера |
| CodeSandbox | CodeSandbox | Так |
| RingAISynapseFlow | RingAISynapseFlow | Так |
Code |
| Серверний async |
| Timeline | Timeline | Так |
| Math / MathBlock | Math, MathBlock | Так |
| UiCard* | UiCard, … | Зручний для сервера |
| CodeSandbox | CodeSandbox | Так |
| RingAISynapseFlow | RingAISynapseFlow | Так |
Code |
| Серверний async |
| Timeline | Timeline | Так |
| Math / MathBlock | Math, MathBlock | Так |
| UiCard* | UiCard, … | Зручний для сервера |
| CodeSandbox | CodeSandbox | Так |
| RingAISynapseFlow | RingAISynapseFlow | Так |