Public documentation for the Korfix platform — single source of truth for all consumers:
- Miniapp developers (read at docs.korfix.info)
- AI agents via korfixdev/devkit and korfixdev/assistant plugins (pull from this repo)
- Static site builds (MkDocs Material → GitHub Pages)
See src/index.md.
| Folder | Audience | Content |
|---|---|---|
src/miniapps/ |
Marketplace miniapp developers | SDK: config.json, JS API, data API, styling, deploy |
Planned: src/catalogs/ (business catalog reference), src/workflows/ (automation recipes), src/backend/ (public framework architecture).
- Fork → edit → PR. New file — add link to
src/miniapps/index.mdand include "See also" block at top. - Every doc has a top block
> **См. также:**with 2-4 links to related topics and> **← [Home](index.md)**. At the bottom —**Дальше:** X · **← [Home](index.md)**for linear reading, or just← Homefor reference docs. - Code examples should be working — runnable via copy-paste.
The src/ folder is the content root for MkDocs. On every push to main, GitHub Actions builds the Material-themed site and deploys to GitHub Pages → docs.korfix.info.
- korfix.ru — Korfix platform (product)
- korfixdev/devkit — miniapp development plugin
- korfixdev/assistant — business data queries plugin
- github.com/korfixdev — organization
CC BY-SA 4.0 — attribution required, derivatives under same license.
Публичная документация платформы Korfix — источник правды для всех потребителей:
- Разработчики миниапов (читают на docs.korfix.info)
- AI-агенты через плагины korfixdev/devkit и korfixdev/assistant (подтягивают этот репо)
- Сборка статического сайта (MkDocs Material → GitHub Pages)
См. src/index.md.
| Папка | Аудитория | Содержание |
|---|---|---|
src/miniapps/ |
Разработчики маркетплейс-миниапов | SDK: config.json, JS API, data API, стилизация, деплой |
В будущем: src/catalogs/ (справочник бизнес-каталогов), src/workflows/ (рецепты автоматизации), src/backend/ (архитектура ядра).
- Fork → правка → PR. Новый файл — обязательно добавь ссылку в
src/miniapps/index.mdи блок «См. также» в шапку. - Каждый документ содержит вверху блок
> **См. также:**с 2-4 ссылками на смежные темы и> **← [Home](index.md)**. Внизу —**Дальше:** X · **← [Home](index.md)**для линейного чтения, или только← Homeдля справочников. - Примеры кода — рабочие, должны запускаться копипастой.
Папка src/ — корень контента для MkDocs. При каждом push в main GitHub Actions собирает Material-сайт и деплоит на GitHub Pages → docs.korfix.info.
- korfix.ru — платформа Korfix (продукт)
- korfixdev/devkit — плагин для разработки миниапов
- korfixdev/assistant — плагин для бизнес-запросов
- github.com/korfixdev — организация
CC BY-SA 4.0 — атрибуция обязательна, производные работы под той же лицензией.