Skip to content
Kumquat
Esc
↑↓navigate↵open⌘Jpreview
On this page

Документація Kumquat

Інструментарій креативної команди.

Тут зібрана вся документація по бекенду й фронтенду, а також довідник API, згенерований зі схеми самого застосунку.

Як це зібрано

Сайт будує Blume із markdown-файлів у docs/. Сторінки, навігація й пошук виводяться зі структури папок — щоб додати сторінку, достатньо покласти .md файл у потрібну теку й прописати title та description у frontmatter.

npm run docs:dev        # локальний сервер із hot-reload
npm run docs:build      # продакшн-збірка в dist/
npm run docs:validate   # перевірка внутрішніх посилань

Довідник API читається напряму з backend/openapi.json, який комітиться в репо й перевіряється воркфлоу api-contract, тож він не може розійтися з бекендом.

Was this page helpful?