update documentation and specs

This commit is contained in:
Forbes
2026-01-29 13:10:12 -06:00
parent d886a44288
commit f39aef0fc7
10 changed files with 546 additions and 1224 deletions

View File

@@ -1,10 +1,10 @@
# Silo
# Kindred Silo
Item database and part management system for FreeCAD.
Item database and part management system for Kindred Create.
## Overview
Silo is an R&D-oriented item database with:
Kindred Silo is an R&D-oriented item database with:
- **Configurable part number generation** via YAML schemas
- **FreeCAD integration** with git-like commands (checkout, commit, status)
@@ -20,20 +20,19 @@ silo/
│ ├── silo/ # CLI tool
│ └── silod/ # API server
├── internal/
│ ├── api/ # HTTP handlers, routes, and templates
│ ├── config/ # Configuration loading
│ ├── db/ # PostgreSQL access
│ ├── schema/ # YAML schema parsing
│ ├── storage/ # MinIO file storage
│ ├── migration/ # Property migration utilities
│ ├── partnum/ # Part number generation
│ ├── inventory/ # Location and stock management
│ └── api/ # HTTP handlers
│ ├── schema/ # YAML schema parsing
│ └── storage/ # MinIO file storage
├── pkg/
│ └── freecad/ # FreeCAD workbench (Python)
├── web/
│ ├── templates/ # HTML templates
│ └── static/ # CSS, JS assets
├── migrations/ # Database migrations
├── schemas/ # Example YAML schemas
├── migrations/ # Database migration SQL scripts
├── schemas/ # Part numbering schema definitions (YAML)
├── deployments/ # Docker Compose and systemd configs
├── scripts/ # Deployment and setup scripts
└── docs/ # Documentation
```
@@ -51,26 +50,29 @@ cp config.example.yaml config.yaml
go run ./cmd/silod
# CLI usage
go run ./cmd/silo register --schema kindred-rd --project PROTO --type AS
go run ./cmd/silo register --schema kindred-rd --category F01
```
## Configuration
See `config.example.yaml` for all options.
## FreeCAD Integration
## Kindred Create Integration
Install the workbench:
```bash
ln -s $(pwd)/pkg/freecad ~/.local/share/FreeCAD/Mod/Silo
ln -s $(pwd)/pkg/freecad ~/.local/share/FreeCAD/Mod/KindredSilo
```
Then in FreeCAD:
- `silo checkout PROTO-AS-0001`
- `silo commit -m "Updated dimensions"`
- `silo status`
Then in Kindred Create, use the Silo workbench toolbar commands:
- **Pull** - Download an item by part number
- **Commit** - Save current state as a new revision with comment
- **Push** - Batch upload modified files
- **Info** - View revision history
## License
Proprietary - Kindred Systems LLC
MIT License - Copyright (c) 2026 Kindred Systems LLC
See [LICENSE](LICENSE) for details.