Skip to content

Documentation Map

rkfsociety edited this page Oct 21, 2026 · 6 revisions

Русский · English · Source

CADYX documentation map

Русский · English

Русский

Источник истины — текущий код main, прежде всего cadyx/migrations.py, cadyx/capabilities.py, cadyx/web_routes.py, cadyx/api_contracts.py и тесты. Карта служит навигацией, а не дополнительной спецификацией. Оболочка проекта — v1, документ — v12, граф сборки — v3. Старые версии контрактов описывают возможности на момент их введения; поздние версии могут менять ограничения.

Начало работы

Контракты по темам

Область Документация
Плоскости эскизов, документ v12 XY/XZ/YZ, CUSTOM и FACE
Профили и зависимые тела Базовый контракт v7, сложные тела EN · RU, трассировка кривых EN · RU
Параметры и перестроение Документ v8 EN · RU
Сборки, сопряжения и материалы v9 EN · RU, v10 EN · RU, v11 EN · RU
Масса и зазоры сборки Масса EN · RU, положения EN · RU
Проверка геометрии Инженерные проверки EN · RU, спецификации модели EN · RU, проверка проекта EN · RU
История ревизий Сравнение моделей EN · RU
Реконструкция по сканам Сетка → CAD EN · RU, STL-референсы EN · RU
Облака точек Обработка EN · RU
Треугольные сетки Обработка EN · RU
Опоры для реконструкции Распознавание EN · RU
Стандартные детали Каталог EN · RU
Отложенные инструменты Backlog эскизов EN · RU
Revopoint Инструменты сканера EN · RU, калибровка RU/EN

Версии и достоверность

Исторические v4 EN · RU, v5 EN · RU, v6 EN · RU и v7 EN · RU описывают последовательные изменения эскизов, геометрии и импорта. v8 добавила параметры; v9 — граф сборки v1; v10 — сопряжения и граф v2; v11 · RU — материалы и граф v3; v12 EN · RU — сохраняемые плоскости эскизов.

Текущие команды доступны через GET /api/v1/agent/capabilities, ограниченная инспекция — через GET /api/v1/agent/projects/{id}/inspection. CI содержит source-проверки и нативные Windows-проверки. Документационная правка не подтверждает прохождение нативных тестов.

План развития, решения и память содержат контекст и намерения; не используйте их как перечень текущих возможностей без проверки кода.

Языковое покрытие

README, эта карта, руководства участия, безопасности, выпуска и сканера содержат русскую и английскую версии. Запуск описан в отдельных RU/EN-руководствах. Для каждой текущей технической спецификации есть полный русский аналог; Wiki содержит RU/EN-навигацию и соответствующие страницы. При добавлении спецификации обновляйте обе языковые версии и карту документации. Имена API, поля JSON, команды и пути сохраняются без перевода. Агентные правила и рабочая память .codex/ не являются пользовательской локализацией.

English

Source of truth: current main implementation, particularly cadyx/migrations.py, cadyx/capabilities.py, cadyx/web_routes.py, cadyx/api_contracts.py and the tests. This map is an entry point, not an extra versioned specification. The project envelope is v1, the document schema is v12, and the assembly graph schema is v3 (introduced in Document v11). Older document-model files record an introduction-era contract; later versions can supersede their stated limitations.

Get started and operate

Current capabilities by topic

Area Contract
Sketch work planes, Document v12 Named YZ, CUSTOM and FACE EN · RU
Sketch profiles and dependent solids Document v7 base contract · RU, advanced solids · RU, curve tracing · RU
Parameters and atomic rebuilds Document v8 · RU
Assembly graph, mates, materials v9 EN · RU, v10 EN · RU, v11 EN · RU
Assembly properties and fit Mass/inertia, discrete-pose fit
Geometry verification Engineering validation, model specifications, project checks
Revision history and comparison Revision diff
PLY/scan reverse engineering Mesh-based scan-to-CAD, STL references · RU
Point-only cloud cleanup and history Processing tools and persisted stages
Triangle-mesh cleanup and smoothing Agent mesh processing
Reconstruction datums, sections and support curves Mesh recognition
Catalog and standard parts Standard-part presets
Backlog, not implemented feature list Sketch tool backlog EN · RU
Revopoint scanner tooling Scanner README EN · RU, calibration notes RU/EN

Version history (not current-limit declarations)

Validation and scope

GET /api/v1/agent/capabilities discovers runtime routes and commands, and GET /api/v1/agent/projects/{id}/inspection supplies bounded read-only project inspection. Programmatic source/contract checks are in CI. Tests that require Windows native OCCT/Open3D must run in the configured Windows environment. A source review or documentation-only commit is not evidence that native tests passed.

The project roadmap, architectural decisions, and memory record history, design intent, and pending work; they must not be treated as a live capability inventory without cross-checking code.

Language coverage

The README, this map, contribution guide, security policy, release readiness guide and scanner manual have Russian and English versions. Setup has separate RU/EN guides. Every current technical specification has a full Russian counterpart, and the Wiki contains matching RU/EN navigation and pages. Update both language versions and the documentation map when adding a specification. API identifiers, JSON keys, commands and paths stay unchanged. Agent rules and working memory are not user-facing localization.

Clone this wiki locally