|
| 1 | +<!-- SPDX-License-Identifier: PMPL-1.0-or-later --> |
| 2 | +<!-- TOPOLOGY.md — Project architecture map and completion dashboard --> |
| 3 | +<!-- Last updated: 2026-02-19 --> |
| 4 | + |
| 5 | +# FireFlag — Project Topology |
| 6 | + |
| 7 | +## System Architecture |
| 8 | + |
| 9 | +``` |
| 10 | + ┌─────────────────────────────────────────┐ |
| 11 | + │ FIREFOX USER │ |
| 12 | + │ (about:config Management) │ |
| 13 | + └──────────┬───────────────────┬──────────┘ |
| 14 | + │ │ |
| 15 | + ▼ ▼ |
| 16 | + ┌───────────────────┐ ┌───────────────────┐ |
| 17 | + │ EXTENSION POPUP │ │ SIDEBAR PANEL │ |
| 18 | + │ (Search & Toggle) │ │ (History & Export)│ |
| 19 | + └──────────┬────────┘ └──────────┬────────┘ |
| 20 | + │ │ |
| 21 | + └──────────┬───────────┘ |
| 22 | + │ |
| 23 | + ▼ |
| 24 | + ┌─────────────────────────────────────────┐ |
| 25 | + │ SERVICE WORKER (BG) │ |
| 26 | + │ (Browser API, Storage Orchestrator) │ |
| 27 | + └──────────┬───────────────────┬──────────┘ |
| 28 | + │ │ |
| 29 | + ▼ ▼ |
| 30 | + ┌───────────────────────┐ ┌────────────────────────────────┐ |
| 31 | + │ FLAG DATABASE │ │ SECURITY & PROOFS │ |
| 32 | + │ - 105+ Config Flags │ │ - Idris2 Safety Proofs │ |
| 33 | + │ - Safety Ratings │ │ - CodeQL Static Analysis │ |
| 34 | + │ - Documentation │ │ - SLSA Level 3 Provenance │ |
| 35 | + └──────────┬────────────┘ └────────────────────────────────┘ |
| 36 | + │ |
| 37 | + ▼ |
| 38 | + ┌─────────────────────────────────────────┐ |
| 39 | + │ FIREFOX GECKO CORE │ |
| 40 | + │ (Pref Service, about:config) │ |
| 41 | + └─────────────────────────────────────────┘ |
| 42 | +
|
| 43 | + ┌─────────────────────────────────────────┐ |
| 44 | + │ REPO INFRASTRUCTURE │ |
| 45 | + │ Justfile / web-ext .machine_readable/ │ |
| 46 | + │ Guix / Chainguard RSR Gold (100%) │ |
| 47 | + └─────────────────────────────────────────┘ |
| 48 | +``` |
| 49 | + |
| 50 | +## Completion Dashboard |
| 51 | + |
| 52 | +``` |
| 53 | +COMPONENT STATUS NOTES |
| 54 | +───────────────────────────────── ────────────────── ───────────────────────────────── |
| 55 | +EXTENSION UI |
| 56 | + Browser Action Popup ██████████ 100% Search & toggle stable |
| 57 | + Sidebar Panel ██████████ 100% History & export verified |
| 58 | + DevTools Panel ██████████ 100% Impact analysis active |
| 59 | + Options Page ██████████ 100% Permission management stable |
| 60 | +
|
| 61 | +CORE & DATABASE |
| 62 | + Flag Database (105 flags) ██████████ 100% Safety documentation complete |
| 63 | + Background Service Worker ██████████ 100% Storage orchestration verified |
| 64 | + Idris2 Safety Proofs ██████████ 100% Verified ABI boundary |
| 65 | +
|
| 66 | +REPO INFRASTRUCTURE |
| 67 | + Justfile Automation ██████████ 100% Standard build/lint/run |
| 68 | + .machine_readable/ ██████████ 100% STATE.scm tracking |
| 69 | + Guix / Chainguard Build ██████████ 100% Reproducible .xpi package |
| 70 | +
|
| 71 | +───────────────────────────────────────────────────────────────────────────── |
| 72 | +OVERALL: ██████████ 100% v0.1.0 Ready for Submission |
| 73 | +``` |
| 74 | + |
| 75 | +## Key Dependencies |
| 76 | + |
| 77 | +``` |
| 78 | +Idris2 Proofs ───► Background ──────► Browser Storage ───► Firefox Prefs |
| 79 | + │ │ │ |
| 80 | + ▼ ▼ ▼ |
| 81 | +ReScript Types ──► Extension UI ────► Flag Metadata |
| 82 | +``` |
| 83 | + |
| 84 | +## Update Protocol |
| 85 | + |
| 86 | +This file is maintained by both humans and AI agents. When updating: |
| 87 | + |
| 88 | +1. **After completing a component**: Change its bar and percentage |
| 89 | +2. **After adding a component**: Add a new row in the appropriate section |
| 90 | +3. **After architectural changes**: Update the ASCII diagram |
| 91 | +4. **Date**: Update the `Last updated` comment at the top of this file |
| 92 | + |
| 93 | +Progress bars use: `█` (filled) and `░` (empty), 10 characters wide. |
| 94 | +Percentages: 0%, 10%, 20%, ... 100% (in 10% increments). |
0 commit comments