kindred/silo
1
1
Fork 0
Code Issues 29 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: update README.md with Calc extension, auth system, and complete component map #3

New Issue
Closed
opened 2026-02-06 18:20:14 +00:00 by forbes · 0 comments
forbes commented 2026-02-06 18:20:14 +00:00
Owner
Copy Link

Problem

README.md is minimal and missing major components of the project. A new user reading only the README would not know about the Calc extension, authentication, ODS import/export, BOM features, or the audit system.

What's Missing from README.md

LibreOffice Calc Extension (pkg/calc/)

  • Not mentioned at all
  • 8 toolbar commands: Login, Pull BOM, Pull Project, Push, Add Item, Refresh, Settings, AI Describe
  • 31 unit tests
  • Full BOM sync, project sheet generation, AI-assisted property extraction
  • .oxt packaging for LibreOffice installation

Authentication System

  • README says nothing about auth
  • Three backends implemented: local (bcrypt), LDAP/FreeIPA, OIDC/Keycloak
  • Role-based access control (admin/editor/viewer)
  • API token management
  • Session-based and token-based auth

Component Map is Incomplete

Current component tree in README is missing:

  • internal/auth/ — Authentication backends
  • internal/odoo/ — Odoo ERP integration stubs
  • internal/ods/ — LibreOffice ODS file handling
  • pkg/calc/ — LibreOffice Calc extension (entire directory)

BOM Features

  • Multi-level BOM with recursive expansion
  • Where-used (reverse lookup)
  • BOM CSV and ODS import/export
  • Cycle detection

ODS Import/Export

  • Item export/import as ODS spreadsheets
  • BOM export as ODS
  • Project sheet generation
  • Sheet diff (compare ODS against database)

Audit/Completeness System

  • Weighted completeness scoring per item
  • Category-specific property validation
  • Tier classification (critical/low/partial/good/complete)

Quick Start is Outdated

  • Shows manual psql -f migrations/001_initial.sql — there are 10 migrations now
  • Does not mention make migrate or Docker Compose
  • Does not mention configuring auth or creating default admin account

Tasks

  • Add Calc extension to component tree and create a brief description section
  • Add auth system section with overview of backends and configuration
  • Update component tree to include auth, odoo, ods, calc directories
  • Add BOM features overview
  • Update Quick Start to use make docker-up or make migrate and mention all 10 migrations
  • Add mention of audit/completeness system
  • Reference detailed docs (AUTH.md, CALC_EXTENSION.md, DEPLOYMENT.md, etc.)
## Problem README.md is minimal and missing major components of the project. A new user reading only the README would not know about the Calc extension, authentication, ODS import/export, BOM features, or the audit system. ## What's Missing from README.md ### LibreOffice Calc Extension (`pkg/calc/`) - Not mentioned at all - 8 toolbar commands: Login, Pull BOM, Pull Project, Push, Add Item, Refresh, Settings, AI Describe - 31 unit tests - Full BOM sync, project sheet generation, AI-assisted property extraction - `.oxt` packaging for LibreOffice installation ### Authentication System - README says nothing about auth - Three backends implemented: local (bcrypt), LDAP/FreeIPA, OIDC/Keycloak - Role-based access control (admin/editor/viewer) - API token management - Session-based and token-based auth ### Component Map is Incomplete Current component tree in README is missing: - `internal/auth/` — Authentication backends - `internal/odoo/` — Odoo ERP integration stubs - `internal/ods/` — LibreOffice ODS file handling - `pkg/calc/` — LibreOffice Calc extension (entire directory) ### BOM Features - Multi-level BOM with recursive expansion - Where-used (reverse lookup) - BOM CSV and ODS import/export - Cycle detection ### ODS Import/Export - Item export/import as ODS spreadsheets - BOM export as ODS - Project sheet generation - Sheet diff (compare ODS against database) ### Audit/Completeness System - Weighted completeness scoring per item - Category-specific property validation - Tier classification (critical/low/partial/good/complete) ### Quick Start is Outdated - Shows manual `psql -f migrations/001_initial.sql` — there are 10 migrations now - Does not mention `make migrate` or Docker Compose - Does not mention configuring auth or creating default admin account ## Tasks - [ ] Add Calc extension to component tree and create a brief description section - [ ] Add auth system section with overview of backends and configuration - [ ] Update component tree to include auth, odoo, ods, calc directories - [ ] Add BOM features overview - [ ] Update Quick Start to use `make docker-up` or `make migrate` and mention all 10 migrations - [ ] Add mention of audit/completeness system - [ ] Reference detailed docs (AUTH.md, CALC_EXTENSION.md, DEPLOYMENT.md, etc.)
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
No items
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
forbes
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: kindred/silo#3
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?