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

docs: update stale SPECIFICATION, ROADMAP, STATUS, and GAP_ANALYSIS to reflect actual implementation #1

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

Problem

Multiple core documentation files significantly underrepresent what is actually implemented, actively misleading about the project's capabilities.

Stale Claims

SPECIFICATION.md

  • Section 10 says "Single-user, no authentication" — but full multi-backend auth exists (local, LDAP, OIDC, API tokens, sessions, RBAC)
  • Section 11 lists ~30 API endpoints — 50+ routes are actually registered
  • No mention of ODS endpoints, audit endpoints, or auth endpoints

ROADMAP.md

  • Multi-level BOM listed as Phase 5 (Q1-Q2 2027) — already fully implemented with recursive CTEs
  • Where-used listed as Phase 4 (Q4 2026) — already fully implemented
  • BOM export listed as Phase 5 — CSV and ODS export both working
  • Authentication listed as Phase 2 (Q2-Q3 2026) — already implemented (3 backends + RBAC)
  • Audit logging listed as Phase 2 — database schema + handlers exist
  • Feature comparison matrix at the bottom shows "No" for features that are complete

STATUS.md

  • Lists only 7 migrations — 10 exist (009_auth, 010_item_extended_fields)
  • Says "No test coverage" — Calc extension has 31 unit tests
  • Does not mention auth, Odoo stubs, ODS features, or audit system
  • "Not Yet Implemented" section lists auth and audit as not started

GAP_ANALYSIS.md

  • Lists "Authentication: None", "Audit logging: None", "Role-based permissions: None"
  • All of these are implemented
  • Recommended implementation order lists items as "Next" that are already done

Documents That ARE Accurate

  • AUTH.md, AUTH_MIDDLEWARE.md, AUTH_USER_GUIDE.md — these correctly describe the auth system
  • CALC_EXTENSION.md — accurately documents the Calc extension
  • DEPLOYMENT.md — current and correct
  • REPOSITORY_STATUS.md — mostly accurate route listing, but doesn't call out contradictions with other docs

Cross-Document Contradictions

  • REPOSITORY_STATUS.md correctly lists expanded BOM and where-used routes, but ROADMAP.md says they are planned for 2027
  • AUTH.md documents the full auth system, but SPECIFICATION.md says auth does not exist

Tasks

  • Update SPECIFICATION.md Section 10 (Authentication) to reflect implemented system
  • Update SPECIFICATION.md Section 11 (API) to list all 50+ endpoints
  • Update ROADMAP.md phase statuses — mark completed features, adjust timeline
  • Update ROADMAP.md feature comparison matrix
  • Update STATUS.md to include migrations 008-010, auth, ODS, audit
  • Update GAP_ANALYSIS.md to mark implemented gaps as complete
  • Ensure no cross-document contradictions remain
## Problem Multiple core documentation files significantly underrepresent what is actually implemented, actively misleading about the project's capabilities. ## Stale Claims ### SPECIFICATION.md - Section 10 says "Single-user, no authentication" — but full multi-backend auth exists (local, LDAP, OIDC, API tokens, sessions, RBAC) - Section 11 lists ~30 API endpoints — 50+ routes are actually registered - No mention of ODS endpoints, audit endpoints, or auth endpoints ### ROADMAP.md - Multi-level BOM listed as Phase 5 (Q1-Q2 2027) — already fully implemented with recursive CTEs - Where-used listed as Phase 4 (Q4 2026) — already fully implemented - BOM export listed as Phase 5 — CSV and ODS export both working - Authentication listed as Phase 2 (Q2-Q3 2026) — already implemented (3 backends + RBAC) - Audit logging listed as Phase 2 — database schema + handlers exist - Feature comparison matrix at the bottom shows "No" for features that are complete ### STATUS.md - Lists only 7 migrations — 10 exist (009_auth, 010_item_extended_fields) - Says "No test coverage" — Calc extension has 31 unit tests - Does not mention auth, Odoo stubs, ODS features, or audit system - "Not Yet Implemented" section lists auth and audit as not started ### GAP_ANALYSIS.md - Lists "Authentication: None", "Audit logging: None", "Role-based permissions: None" - All of these are implemented - Recommended implementation order lists items as "Next" that are already done ## Documents That ARE Accurate - AUTH.md, AUTH_MIDDLEWARE.md, AUTH_USER_GUIDE.md — these correctly describe the auth system - CALC_EXTENSION.md — accurately documents the Calc extension - DEPLOYMENT.md — current and correct - REPOSITORY_STATUS.md — mostly accurate route listing, but doesn't call out contradictions with other docs ## Cross-Document Contradictions - REPOSITORY_STATUS.md correctly lists expanded BOM and where-used routes, but ROADMAP.md says they are planned for 2027 - AUTH.md documents the full auth system, but SPECIFICATION.md says auth does not exist ## Tasks - [ ] Update SPECIFICATION.md Section 10 (Authentication) to reflect implemented system - [ ] Update SPECIFICATION.md Section 11 (API) to list all 50+ endpoints - [ ] Update ROADMAP.md phase statuses — mark completed features, adjust timeline - [ ] Update ROADMAP.md feature comparison matrix - [ ] Update STATUS.md to include migrations 008-010, auth, ODS, audit - [ ] Update GAP_ANALYSIS.md to mark implemented gaps as complete - [ ] Ensure no cross-document contradictions remain
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#1
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?