|
| 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 | +# Modshells — Project Topology |
| 6 | + |
| 7 | +## System Architecture |
| 8 | + |
| 9 | +``` |
| 10 | + ┌─────────────────────────────────────────┐ |
| 11 | + │ SHELL USER │ |
| 12 | + │ (Bash, Zsh, Fish, Nushell, etc.) │ |
| 13 | + └───────────────────┬─────────────────────┘ |
| 14 | + │ |
| 15 | + ▼ |
| 16 | + ┌─────────────────────────────────────────┐ |
| 17 | + │ MODSHELLS CLI (ADA) │ |
| 18 | + │ (Idempotent Configuration Manager) │ |
| 19 | + └──────────┬───────────────────┬──────────┘ |
| 20 | + │ │ |
| 21 | + ▼ ▼ |
| 22 | + ┌───────────────────────┐ ┌────────────────────────────────┐ |
| 23 | + │ SHELL MANAGER │ │ CONFIG STORE │ |
| 24 | + │ - Shell Detection │ │ - Path Resolution │ |
| 25 | + │ - Sourcing Injection │ │ - Idempotency Checks │ |
| 26 | + │ - Config Backups │ │ - Directory Scaffolding │ |
| 27 | + └──────────┬────────────┘ └──────────┬─────────────────────┘ |
| 28 | + │ │ |
| 29 | + └────────────┬─────────────┘ |
| 30 | + ▼ |
| 31 | + ┌─────────────────────────────────────────┐ |
| 32 | + │ MODULAR CONFIG HUB │ |
| 33 | + │ ┌───────────┐ ┌───────────┐ ┌───────┐│ |
| 34 | + │ │ core/ │ │ tools/ │ │ misc/ ││ |
| 35 | + │ └───────────┘ └───────────┘ └───────┘│ |
| 36 | + │ ┌───────────┐ ┌───────────┐ │ |
| 37 | + │ │ os/ │ │ ui/ │ │ |
| 38 | + │ └───────────┘ └───────────┘ │ |
| 39 | + └─────────────────────────────────────────┘ |
| 40 | +
|
| 41 | + ┌─────────────────────────────────────────┐ |
| 42 | + │ REPO INFRASTRUCTURE │ |
| 43 | + │ GPRBuild / Ada .machine_readable/ │ |
| 44 | + │ Smoke Tests (Sh) 0-AI-MANIFEST.a2ml │ |
| 45 | + └─────────────────────────────────────────┘ |
| 46 | +``` |
| 47 | + |
| 48 | +## Completion Dashboard |
| 49 | + |
| 50 | +``` |
| 51 | +COMPONENT STATUS NOTES |
| 52 | +───────────────────────────────── ────────────────── ───────────────────────────────── |
| 53 | +CORE MANAGER (ADA) |
| 54 | + Shell Detection ██████████ 100% 10+ shells supported |
| 55 | + Directory Scaffolding ██████████ 100% Idempotent creation stable |
| 56 | + Source Injection ██████████ 100% Shell-specific syntax verified |
| 57 | + Config Backup (Timestamped) ██████████ 100% Verification before edit stable |
| 58 | +
|
| 59 | +INTERFACES & CONFIG |
| 60 | + CLI Interface (modshells) ██████████ 100% v0.1 core functional |
| 61 | + Environment Path Resolution ██████████ 100% MODSHELLS_CONFIG_PATH active |
| 62 | + Idempotency (Signature-based) ██████████ 100% Duplicate prevention verified |
| 63 | +
|
| 64 | +REPO INFRASTRUCTURE |
| 65 | + GPRBuild Automation ██████████ 100% Standard build tasks |
| 66 | + .machine_readable/ ██████████ 100% STATE tracking active |
| 67 | + Smoke & Unit Tests ██████████ 100% Full core logic coverage |
| 68 | +
|
| 69 | +───────────────────────────────────────────────────────────────────────────── |
| 70 | +OVERALL: ██████████ 100% v0.1 Core complete & stable |
| 71 | +``` |
| 72 | + |
| 73 | +## Key Dependencies |
| 74 | + |
| 75 | +``` |
| 76 | +Shell Binary ──────► Detection Logic ───► Backup Config ──► Sourcing Injected |
| 77 | + │ │ │ │ |
| 78 | + ▼ ▼ ▼ ▼ |
| 79 | +Config Path ───────► Scaffolding ──────► Module Hub ──────► Shell Env |
| 80 | +``` |
| 81 | + |
| 82 | +## Update Protocol |
| 83 | + |
| 84 | +This file is maintained by both humans and AI agents. When updating: |
| 85 | + |
| 86 | +1. **After completing a component**: Change its bar and percentage |
| 87 | +2. **After adding a component**: Add a new row in the appropriate section |
| 88 | +3. **After architectural changes**: Update the ASCII diagram |
| 89 | +4. **Date**: Update the `Last updated` comment at the top of this file |
| 90 | + |
| 91 | +Progress bars use: `█` (filled) and `░` (empty), 10 characters wide. |
| 92 | +Percentages: 0%, 10%, 20%, ... 100% (in 10% increments). |
0 commit comments