Как писать статьи
Где лежат страницы и как устроены компоненты. Правила для агентов — в apps/docs/AGENTS.md.
Статьи — файлы в git, не записи в CMS. Правила для следующих агентов собраны в apps/docs/AGENTS.md. Здесь — короткая карта и живые примеры.
Где что лежит
| Что | Путь |
|---|---|
| Статьи | apps/docs/content/docs/ |
| Порядок в боковой панели | meta.json рядом со статьями |
| Картинки | apps/docs/public/images/ |
| Справочник API | apps/docs/content/docs/api/reference/, только генератор |
| Снимок OpenAPI | apps/docs/generated/openapi.json и копия apps/docs/public/openapi.json |
Язык первого выпуска — русский, каталог content/docs без префикса локали. Переключатель языка не показывается, пока нет второго перевода. Когда он появится, страницы разъедутся по content/docs/ru и content/docs/en, и только тогда включается i18n Fumadocs.
Как добавить страницу
- Файл
content/docs/<раздел>/<имя>.mdxили.mdс полямиtitleиdescription. - Имя файла — в
pagesфайлаmeta.jsonэтого раздела. - Ссылка из соседней статьи ведёт на
/docs/<раздел>/<имя>/. - Если страницу нужно открывать редиректом с приложения, её путь добавляется в
apps/web/src/lib/docs-portal.ts. Неизвестный путь приложение не перенаправляет.
Непроверенный перенос помечается компонентом <ReviewNote /> в начале статьи. Исправленное при переносе так не помечается: в тексте прямо сказано, что изменилось.
Примеры
- Обычный Markdown — файл
.mdбез компонентов. - Компоненты MDX — примечания, шаги, вкладки, код, таблица, картинка, подробности и ссылка на другую статью.
Картинки меняющегося интерфейса сюда не кладутся, пока экраны не устаканятся. Демонстрационный файл — public/images/sample-column.svg, и подпись обязана говорить, что это не скриншот.