louis/gigafibre-fsm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
90f5f2eaa0
gigafibre-fsm/docs/archive/HANDOFF-2026-04-18.md
louispaulb beb6ddc5e5 docs: reorganize into architecture/features/reference/archive folders 
All docs moved with git mv so --follow preserves history. Flattens the
single-folder layout into goal-oriented folders and adds a README.md index
at every level.

- docs/README.md — new landing page with "I want to…" intent table
- docs/architecture/ — overview, data-model, app-design
- docs/features/ — billing-payments, cpe-management, vision-ocr, flow-editor
- docs/reference/ — erpnext-item-diff, legacy-wizard/
- docs/archive/ — HANDOFF-2026-04-18, MIGRATION, status-snapshots/
- docs/assets/ — pptx sources, build scripts (fixed hardcoded path)
- roadmap.md gains a "Modules in production" section with clickable
  URLs for every ops/tech/portal route and admin surface
- Phase 4 (Customer Portal) flipped to "Largely Shipped" based on
  audit of services/targo-hub/lib/payments.js (16 endpoints, webhook,
  PPA cron, Klarna BNPL all live)
- Archive files get an "ARCHIVED" banner so stale links inside them
  don't mislead readers

Code comments + nginx configs rewritten to use new doc paths. Root
README.md documentation table replaced with intent-oriented index.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-04-22 11:51:33 -04:00

5.5 KiB
Raw Blame History

Gigafibre FSM — Handoff Index (ARCHIVED 2026-04-18)

⚠️ ARCHIVED. This was the single-page index before the docs were reorganized into folders. Doc paths below are stale — use ../README.md for the current index. Kept for historical reference only.

Purpose (at time of writing): one-page map of every doc in this repo. Pick the path for your role, read in order, stop when you have enough.

Last refreshed: 2026-04-18

Start here (everyone)

# Doc Why
1 STATUS_2026-04-18.md 10-minute snapshot: where the system stands today, what just shipped, what's next
2 ARCHITECTURE.md Service map: ERPNext, Ops PWA, targo-hub, DocuSeal, Authentik, Traefik
3 ROADMAP.md Phases 1 → 5 with completion status

If you only have 15 minutes, read those three.

By role

New engineer joining the project

  1. STATUS_2026-04-18.md — orientation
  2. ARCHITECTURE.md — services and how they talk
  3. DATA_AND_FLOWS.md — ERPNext doctypes + wizard flows
  4. APP_DESIGN_GUIDELINES.md — UI conventions (light mode default, dispatch dark mode exception)
  5. Clone the repo, read README.md, then the apps/ops and services/targo-hub READMEs

Stakeholder / non-technical reader

  1. STATUS_2026-04-18.md — TL;DR + "Where we are" table
  2. Gigafibre-FSM-Features.pptx — feature deck
  3. Gigafibre-Billing-Handoff.pptx — billing migration deck
  4. ROADMAP.md — what's done vs. queued

Accountant / billing ops

  1. BILLING_AND_PAYMENTS.md — full billing architecture, Stripe flow, subscription logic
  2. STATUS_2026-04-18.md §"ERPNext customizations" — custom fields on Item / Quotation Item / Sales Invoice Item
  3. Gigafibre-Billing-Handoff.pptx — visual walkthrough

Dispatcher / field ops lead

  1. STATUS_2026-04-18.md §"Features inventory" — Ops, Dispatch, Field
  2. DATA_AND_FLOWS.md — Issue → Job → Technician flow
  3. CPE_MANAGEMENT.md — CPE lifecycle, GenieACS, modem-bridge
  4. VISION_AND_OCR.md — camera scanning workflow (barcodes, equipment labels, invoices) and offline queue

Infrastructure / DevOps

  1. ARCHITECTURE.md — network + container map
  2. STATUS_2026-04-18.md §"Integrations" — external services and credentials location
  3. CPE_MANAGEMENT.md — GenieACS + OLT + SNMP
  4. VISION_AND_OCR.md — Gemini pipeline, AI_API_KEY config, hub /vision/* endpoints

Document catalog

Doc What it covers When to read
STATUS_2026-04-18.md Full state snapshot, features, integrations, known issues, gotchas Always first
ARCHITECTURE.md Services, containers, networks, routes Onboarding or infra changes
ROADMAP.md Phase plan with checkboxes Planning or standups
DATA_AND_FLOWS.md Data model and user/workflow flows Building features that touch ERPNext
BILLING_AND_PAYMENTS.md Subscription lifecycle, invoice generation, Stripe, payment reconciliation Billing work
CPE_MANAGEMENT.md CPE database, GenieACS, provisioning, diagnostics CPE or network work
VISION_AND_OCR.md Gemini-via-hub pipeline: barcode/equipment/invoice endpoints, scanner composable, offline retry queue Camera/scan/OCR work, onboarding anyone who'll touch /vision/*
APP_DESIGN_GUIDELINES.md UI tokens, theming, component conventions Frontend work
Gigafibre-FSM-Features.pptx Feature deck for demo / training Sharing with non-engineers
Gigafibre-Billing-Handoff.pptx Billing deck for finance handoff Sharing with finance team
archive/ Deprecated docs kept for reference Historical questions only

Conventions used across these docs

  • Status emoji: ✅ shipped · 🚧 in progress · 🆕 just shipped this cycle · ⏸ paused · 🗃 legacy/read-only
  • Brand: "Gigafibre" = consumer-facing brand, "TARGO" = parent company (both appear; not a rename)
  • Environments: production-only at erp.gigafibre.ca. Legacy DB on 10.100.80.100 is read-only.
  • Dates: always ISO (YYYY-MM-DD). "Current" means 2026-04-18 unless noted.

Where things live outside this repo

  • Memory notes: ~/.claude/projects/-Users-louispaul-Documents-testap/memory/ — context for Claude across sessions
  • Production server: ssh root@96.125.196.67 (ssh-agent + ~/.ssh/proxmox_vm)
  • ERPNext containers: frappe_docker-backend-1, frappe_docker-db-1 (PostgreSQL)
  • targo-hub: /opt/targo-hub/ on prod (volume-mounted lib/)
  • DocuSeal: /opt/docuseal/ on prod

Next doc-writing priorities

  • PROVISIONING.md — ONT/OLT/GenieACS workflow when onboarding a new subscriber
  • DEPLOY.md — step-by-step deploy for each app (currently scattered across feedback memory)
  • INCIDENTS.md — post-mortem log format + template

Add new docs to the catalog table above when you create them.