Reactive EngineeringRE Docs

Doc-Portal

Шаблон портала документации Reactive Engineering — назначение, состав и порядок работы.

Doc-Portal — шаблон для быстрого развертывания порталов документации Reactive Engineering. Из репозитория разворачивается готовый сайт: брендированный интерфейс, поиск, машиночитаемые представления страниц, CI и Docker-сборка. Остается наполнить его содержимым.

Что входит в шаблон

Технологический стек

СлойРешение
ФреймворкNext.js 16, App Router, React 19
Движок документацииFumadocs 16 (fumadocs-core, fumadocs-mdx, @fumadocs/base-ui)
Формат контентаMDX с поддержкой Mermaid
СтилиTailwind CSS 4, брендовые токены Reactive Engineering
ШрифтыNunito Sans (текст), Ubuntu (заголовки и выделения)
Сборка и публикацияDocker (standalone-режим Next.js), GitHub Actions, Dokploy

Принцип наполнения

Один продукт — один каталог верхнего уровня в content/docs/ с признаком "root": true. Такой каталог становится отдельным пунктом выпадающего списка над боковым меню, а его вложенные каталоги — разделами документации этого продукта.

content/docs/
├── meta.json              порядок продуктов
├── index.mdx              обзорная страница /docs
└── doc-portal/            продукт: "root": true → пункт дропдауна
    ├── meta.json
    ├── index.mdx
    ├── getting-started/   раздел
    ├── architecture/      раздел
    ├── how-to/            раздел
    └── brand-and-styles/  раздел

Источник правды

Репозиторная документация в каталоге docs/ и страницы этого раздела описывают одно и то же. При изменении шаблона обновляйте оба места — правило зафиксировано в AGENT.md.

On this page