Files
ss-tools/AGENTS.md
2026-08-13 18:49:37 +03:00

1.4 KiB

ss-tools

Development Environment

  • Рабочий виртуальный окружение (.venv) находится внутри backend/: backend/.venv.

AXIOM doc-gen

Генерация документации (Doxygen/JSDoc) из семантических контрактов выполняется CLI-бинарём doc-gen из Rust-проекта axiom-mcp (соседняя директория ../axiom-mcp).

# 1. Собрать бинарник (один раз)
cargo build --release --bin doc-gen --manifest-path ../axiom-mcp/Cargo.toml

# 2. Переиндексировать workspace и собрать Doxygen HTML
../axiom-mcp/target/release/doc-gen \
  --workspace-root /home/busya/dev/ss-tools \
  --html /tmp/ss-tools-doxygen

# 3. Только навигационный граф (без doxygen)
../axiom-mcp/target/release/doc-gen \
  --workspace-root /home/busya/dev/ss-tools \
  --nav /tmp/ss-tools-nav

Примечания:

  • --workspace-root передавать абсолютным путём (относительный путь ломает проверку safe_join при записи в DuckDB).
  • Результат doxygen: .dox-страницы, Doxyfile и каталог html/ внутри --html-директории.
  • Остальные опции: doc-gen --help (формат, per-file вывод, --filter, --group-cap, --body-lines).