This directory holds the detailed documentation. Each topic has one owner; update that file and link to it instead of copying its content elsewhere.
| Document | Contents |
|---|---|
| ../README.md | Overview, features, installation, quick-start build commands and configuration. Русская версия. |
| FAQ.md | Common questions and troubleshooting: elevation, updates, logs, rules, overlays, macros and configuration recovery. |
| RULE_AUTHORING.md | Command-line rule authoring: commands, JSON format, quotas, validation, share codes. |
| EXAMPLES.md | Complete, ready-to-apply rule recipes. |
| Document | Contents |
|---|---|
| ARCHITECTURE.md | Two tiers, data flow, rule engine, event sources, overlays, input simulation, updates and design conventions. |
| ../CONTRIBUTING.md | Contribution workflow, code style, documentation rules and pull-request process. |
| ../SECURITY.md | Supported versions and private vulnerability reporting. |
| ../CODE_OF_CONDUCT.md | Community standards. |
The project landing page is published from the gh-pages branch:
https://psyattack.github.io/Synector/.
- One owner per topic. Behavior belongs to
ARCHITECTURE.md, CLI and JSON format toRULE_AUTHORING.md, recipes toEXAMPLES.md, user questions toFAQ.md. - Link, do not copy. When a detail is already documented in its owner file, reference it. This
keeps
README.mdand the docs from drifting. - Keep both languages in sync.
README.mdandREADME.ru.mdare mirrors. GUI strings live in both i18n catalogs, and the in-app guide has Russian and English branches. - Update this index when a document is added, renamed or removed.