Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 1.88 KB

README.md

File metadata and controls

37 lines (28 loc) · 1.88 KB

Synector documentation

This directory holds the detailed documentation. Each topic has one owner; update that file and link to it instead of copying its content elsewhere.

Users

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.

Developers

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.

Website

The project landing page is published from the gh-pages branch: https://psyattack.github.io/Synector/.

Documentation rules

  • One owner per topic. Behavior belongs to ARCHITECTURE.md, CLI and JSON format to RULE_AUTHORING.md, recipes to EXAMPLES.md, user questions to FAQ.md.
  • Link, do not copy. When a detail is already documented in its owner file, reference it. This keeps README.md and the docs from drifting.
  • Keep both languages in sync. README.md and README.ru.md are 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.