Menagerie alignment review — architecture, conventions, and shared patterns #1

Closed
opened 2026-03-10 21:21:25 -07:00 by pyr0ball · 1 comment
Owner

Kiwi → Menagerie Alignment Review

Review Kiwi's existing codebase to ensure alignment with CircuitForge's shared conventions, architecture patterns, and design pillars before active development continues.

Scope

  • Folder structure matches the menagerie scaffold (Monitor/Discover → AI Assist → Human Approval → Execute → Track)
  • CLAUDE.md present and up-to-date
  • License headers: MIT (discovery pipeline) / BSL 1.1 (AI features)
  • Tier system stub present (Free/Paid/Premium/Ultra)
  • LLM router pattern matches Peregrine reference implementation
  • SQLite staging DB / status machine pattern
  • Privacy-first data handling (no PII leaves device without explicit consent)
  • Accessibility considerations in any UI components
  • circuitforge-hooks installed
  • README updated to reflect CircuitForge org move

Reference

  • Peregrine is the reference implementation — patterns proven there propagate here
  • See CircuitForge/roadmap#15 for product tracking issue

Notes

Kiwi moved from pyr0ball/thoth (local) — code may predate the shared menagerie scaffold.

## Kiwi → Menagerie Alignment Review Review Kiwi's existing codebase to ensure alignment with CircuitForge's shared conventions, architecture patterns, and design pillars before active development continues. ### Scope - [ ] Folder structure matches the menagerie scaffold (Monitor/Discover → AI Assist → Human Approval → Execute → Track) - [ ] CLAUDE.md present and up-to-date - [ ] License headers: MIT (discovery pipeline) / BSL 1.1 (AI features) - [ ] Tier system stub present (Free/Paid/Premium/Ultra) - [ ] LLM router pattern matches Peregrine reference implementation - [ ] SQLite staging DB / status machine pattern - [ ] Privacy-first data handling (no PII leaves device without explicit consent) - [ ] Accessibility considerations in any UI components - [ ] circuitforge-hooks installed - [ ] README updated to reflect CircuitForge org move ### Reference - Peregrine is the reference implementation — patterns proven there propagate here - See [CircuitForge/roadmap#15](https://git.opensourcesolarpunk.com/Circuit-Forge/roadmap/issues/15) for product tracking issue ### Notes Kiwi moved from `pyr0ball/thoth` (local) — code may predate the shared menagerie scaffold.
pyr0ball added this to the Alpha — Barcode Scan milestone 2026-03-10 21:21:25 -07:00
pyr0ball added this to the The Menagerie project 2026-03-14 16:42:25 -07:00
pyr0ball self-assigned this 2026-03-14 16:42:31 -07:00
pyr0ball added the
enhancement
label 2026-03-14 16:43:41 -07:00
Author
Owner

Alignment review complete — all checklist items resolved:

  • Folder structure matches menagerie scaffold (api→services→tasks = Monitor→AI Assist→Execute→Track)
  • CLAUDE.md — created (gitignored per BSL 1.1 policy)
  • LICENSE-MIT (discovery pipeline) + LICENSE-BSL (AI features) added
  • Tier system — app/tiers.py present
  • LLM router — cf-core llm_router used in expiration_predictor + llm_recipe
  • SQLite status machine — background_tasks with queued/running/completed/failed
  • Privacy-first — PRIVACY.md present; cloud mode uses per-user isolated SQLite trees
  • Accessibility — aria- attributes in Vue components
  • circuitforge-hooks installed (pre-commit gitleaks, commit-msg conventional, pre-push history scan)
  • README reflects CircuitForge org

Bonus: scrubbed .env containing DIRECTUS_JWT_SECRET from full git history via git-filter-repo. Fixed gitleaks false positive in circuitforge-hooks (Python private fn on RHS; regexTarget = match added to global allowlist).

Alignment review complete — all checklist items resolved: - [x] Folder structure matches menagerie scaffold (api→services→tasks = Monitor→AI Assist→Execute→Track) - [x] CLAUDE.md — created (gitignored per BSL 1.1 policy) - [x] LICENSE-MIT (discovery pipeline) + LICENSE-BSL (AI features) added - [x] Tier system — `app/tiers.py` present - [x] LLM router — cf-core `llm_router` used in expiration_predictor + llm_recipe - [x] SQLite status machine — `background_tasks` with queued/running/completed/failed - [x] Privacy-first — PRIVACY.md present; cloud mode uses per-user isolated SQLite trees - [x] Accessibility — `aria-` attributes in Vue components - [x] circuitforge-hooks installed (pre-commit gitleaks, commit-msg conventional, pre-push history scan) - [x] README reflects CircuitForge org Bonus: scrubbed `.env` containing `DIRECTUS_JWT_SECRET` from full git history via git-filter-repo. Fixed gitleaks false positive in circuitforge-hooks (Python private fn on RHS; `regexTarget = match` added to global allowlist).
Sign in to join this conversation.
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: Circuit-Forge/kiwi#1
No description provided.