Nrgy.js Documentation

Purpose

This directory is the main product documentation for Nrgy.js. It explains how to use the library, how its architectural model works, and how to contribute changes back to the repository.

Product Documentation

• Introduction
• Quick Start
• Core
• Architecture
• MVVM and Controllers
• Integrations
• Recipes
• Migration
• FAQ
• Russian version

Suggested Reading Order

1. Start with Introduction.
2. Continue with Quick Start.
3. Then read Core and Architecture.
4. After that move to MVVM and Controllers.
5. Use Integrations, Recipes, Migration, and FAQ during adoption.

Contributing

• Agent Onepager (start here if you are an automated agent)
• Contributor Overview
• Documentation Requirements
• Coding Style
• Development Workflow
• Release Workflow

Package Documentation

• @nrgyjs/core
• @nrgyjs/react
• @nrgyjs/ditox
• @nrgyjs/ditox-react
• @nrgyjs/rxjs
• @nrgyjs/rx-effects

Notes

• Package-level API overviews live in each package README.md.
• Module-level documentation is colocated with source files inside packages/*/src.
• Keep English and Russian documentation in sync.