Документация Nrgy.js
Назначение
Эта директория является основной продуктовой документацией Nrgy.js. Она объясняет, как использовать библиотеку, как устроена её архитектурная модель и как вносить изменения в репозиторий.
Продуктовая документация
Рекомендуемый порядок чтения
- Начать с Введения.
- Затем перейти к Быстрому старту.
- После этого пройти Core и Архитектуру.
- Затем перейти к MVVM и Controllers.
- Во время внедрения использовать Интеграции, Рецепты, Миграцию и FAQ.
Contributing
- Onepager для агентов (стартовая точка для AI-агентов)
- Обзор для контрибьюторов
- Требования к документации
- Стиль кодирования
- Процесс разработки
- Релизный процесс
Документация пакетов
Примечания
- Обзоры публичного API на уровне пакета живут в
README.mdкаждого пакета. - Документация модулей colocated с исходниками внутри
packages/*/src. - Держите английскую и русскую документацию синхронизированной.