From 88e025f1c6081207b3438e11cae55308333009a6 Mon Sep 17 00:00:00 2001 From: forbes Date: Fri, 6 Feb 2026 12:43:04 -0600 Subject: [PATCH] docs: update stale silo/pkg/freecad paths to silo-mod layout --- docs/ARCHITECTURE.md | 21 +++++++++------------ docs/COMPONENTS.md | 6 +++--- docs/INTEGRATION_PLAN.md | 4 +++- 3 files changed, 15 insertions(+), 16 deletions(-) diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index fc77c280f2..79f9138cec 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -7,14 +7,14 @@ FreeCAD startup └─ src/Mod/Create/Init.py └─ setup_kindred_addons() ├─ exec(mods/ztools/ztools/Init.py) - └─ exec(mods/silo/pkg/freecad/Init.py) + └─ exec(mods/silo/freecad/Init.py) └─ src/Mod/Create/InitGui.py ├─ setup_kindred_workbenches() │ ├─ exec(mods/ztools/ztools/InitGui.py) │ │ ├─ registers ZToolsWorkbench │ │ └─ installs _ZToolsPartDesignManipulator (global) - │ └─ exec(mods/silo/pkg/freecad/InitGui.py) + │ └─ exec(mods/silo/freecad/InitGui.py) │ └─ registers SiloWorkbench └─ Deferred setup (QTimer): ├─ 1500ms: _setup_silo_auth_panel() → "Database Auth" dock @@ -43,16 +43,13 @@ mods/ztools/ [submodule] ztools workbench │ └── resources/ Icons, theme utilities └── CatppuccinMocha/ Theme preference pack (QSS) -mods/silo/ [submodule] Silo parts database - ├── cmd/ Go server entry points - ├── internal/ Go API, database, auth, storage packages - ├── pkg/freecad/ FreeCAD workbench (Python) - │ ├── InitGui.py SiloWorkbench - │ ├── silo_commands.py Commands + SiloClient API - │ └── silo_origin.py FileOrigin backend for Silo - ├── pkg/calc/ LibreOffice Calc extension (Python) - ├── deployments/ Docker compose configuration - └── migrations/ PostgreSQL schema migrations (001–010) +mods/silo/ [submodule -> silo-mod.git] FreeCAD workbench + ├── silo-client/ [submodule -> silo-client.git] shared API client + │ └── silo_client/ SiloClient, SiloSettings, CATEGORY_NAMES + └── freecad/ FreeCAD workbench (Python) + ├── InitGui.py SiloWorkbench + ├── silo_commands.py Commands + FreeCADSiloSettings adapter + └── silo_origin.py FileOrigin backend for Silo src/Gui/Stylesheets/ QSS themes and SVG assets resources/preferences/ Canonical preference pack (KindredCreate) diff --git a/docs/COMPONENTS.md b/docs/COMPONENTS.md index 61acf7c942..4d2be85220 100644 --- a/docs/COMPONENTS.md +++ b/docs/COMPONENTS.md @@ -28,7 +28,7 @@ ## Origin commands (C++) -The Origin abstraction (`src/Gui/FileOrigin.h`) provides a backend-agnostic interface for document storage. Commands delegate to the active `FileOrigin` implementation (currently `LocalFileOrigin` for local files, `SiloOrigin` via `mods/silo/pkg/freecad/silo_origin.py` for Silo-tracked documents). +The Origin abstraction (`src/Gui/FileOrigin.h`) provides a backend-agnostic interface for document storage. Commands delegate to the active `FileOrigin` implementation (currently `LocalFileOrigin` for local files, `SiloOrigin` via `mods/silo/freecad/silo_origin.py` for Silo-tracked documents). **Registered commands (5):** @@ -71,7 +71,7 @@ These appear in the File menu and "Origin Tools" toolbar across all workbenches **Server architecture:** Go REST API (38+ routes) + PostgreSQL + MinIO S3. Authentication via local (bcrypt), LDAP, or OIDC backends. See `mods/silo/docs/` for server documentation. -**LibreOffice Calc extension** (`mods/silo/pkg/calc/`): BOM management, item creation, and AI-assisted descriptions via OpenRouter API. Shares the same Silo REST API and auth token system. +**LibreOffice Calc extension** ([silo-calc](https://git.kindred-systems.com/kindred/silo-calc.git)): BOM management, item creation, and AI-assisted descriptions via OpenRouter API. Shares the same Silo REST API and auth token system via the shared [silo-client](https://git.kindred-systems.com/kindred/silo-client.git) package. --- @@ -95,7 +95,7 @@ Four copies must stay in sync: `silo-bom.svg`, `silo-commit.svg`, `silo-info.svg`, `silo-pull.svg`, `silo-push.svg` -### Silo module icons (`mods/silo/pkg/freecad/resources/icons/`) +### Silo module icons (`mods/silo/freecad/resources/icons/`) 10 SVGs loaded at runtime by the `_icon()` function in `silo_commands.py`: diff --git a/docs/INTEGRATION_PLAN.md b/docs/INTEGRATION_PLAN.md index bf97e476db..1f706de2b1 100644 --- a/docs/INTEGRATION_PLAN.md +++ b/docs/INTEGRATION_PLAN.md @@ -134,8 +134,10 @@ install(DIRECTORY ${CMAKE_SOURCE_DIR}/mods/ztools/ztools install(DIRECTORY ${CMAKE_SOURCE_DIR}/mods/ztools/CatppuccinMocha DESTINATION ${CMAKE_INSTALL_DATADIR}/Mod/ztools) -install(DIRECTORY ${CMAKE_SOURCE_DIR}/mods/silo/pkg/freecad/ +install(DIRECTORY ${CMAKE_SOURCE_DIR}/mods/silo/freecad/ DESTINATION ${CMAKE_INSTALL_DATADIR}/Mod/Silo) +install(DIRECTORY ${CMAKE_SOURCE_DIR}/mods/silo/silo-client/ + DESTINATION ${CMAKE_INSTALL_DATADIR}/Mod/silo-client) ``` ---