Add ADR Index and Epics pages

2026-03-17 23:43:29 -07:00
parent 12840919b7
commit 6df619ced8
3 changed files with 56 additions and 1 deletions

20
ADR-Index.md Normal file

@@ -0,0 +1,20 @@
# ADR Index
Architecture Decision Records documenting the "why" behind our architectural choices.
| ADR | Title | Status | Related Issues |
|-----|-------|--------|----------------|
| [ADR-001](ADR-001-Capability-Based-Dependency-Resolution) | Capability-Based Dependency Resolution | ✅ Done | [#7](https://git.notsosm.art/david/Mainline/issues/7) |
| [ADR-002](ADR-002-Stage-Based-Pipeline-Architecture) | Stage-Based Pipeline Architecture | ✅ Done | [#2](https://git.notsosm.art/david/Mainline/issues/2) (Epic) |
| [ADR-003](ADR-003-DataSource-Abstraction) | DataSource Abstraction | ✅ Done | [#10](https://git.notsosm.art/david/Mainline/issues/10), [#11](https://git.notsosm.art/david/Mainline/issues/11) |
| [ADR-004](ADR-004-Display-Protocol-Pattern) | Display Protocol Pattern | ✅ Done | [#12](https://git.notsosm.art/david/Mainline/issues/12), [#13](https://git.notsosm.art/david/Mainline/issues/13), [#14](https://git.notsosm.art/david/Mainline/issues/14) |
| [ADR-005](ADR-005-Sensor-Framework) | Sensor Framework | ✅ Done | [#15](https://git.notsosm.art/david/Mainline/issues/15), [#16](https://git.notsosm.art/david/Mainline/issues/16), [#18](https://git.notsosm.art/david/Mainline/issues/18) |
| [ADR-006](ADR-006-Preset-TOML-Format) | Preset TOML Format | ✅ Done | Part of [#6](https://git.notsosm.art/david/Mainline/issues/6) (Epic) |
## About ADRs
See [Michael Nygard's post](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions) for the origin of this practice.
## Quick Links
- [Home](Home) | [Epics](Epics) | [Issues](https://git.notsosm.art/david/Mainline/issues)

29
Epics.md Normal file

@@ -0,0 +1,29 @@
# Epic Index
Major feature areas organized as Epics and Stories.
## Completed Epics
| Epic | Title | Stories | Status |
|------|-------|---------|--------|
| [#2](https://git.notsosm.art/david/Mainline/issues/2) | Pipeline Architecture Modernization | [#7](https://git.notsosm.art/david/Mainline/issues/7), [#8](https://git.notsosm.art/david/Mainline/issues/8), [#9](https://git.notsosm.art/david/Mainline/issues/9) | ✅ Done |
| [#3](https://git.notsosm.art/david/Mainline/issues/3) | Data Source Unification | [#10](https://git.notsosm.art/david/Mainline/issues/10), [#11](https://git.notsosm.art/david/Mainline/issues/11) | ✅ Done |
| [#4](https://git.notsosm.art/david/Mainline/issues/4) | Display Backend Expansion | [#12](https://git.notsosm.art/david/Mainline/issues/12), [#13](https://git.notsosm.art/david/Mainline/issues/13), [#14](https://git.notsosm.art/david/Mainline/issues/14) | ✅ Done |
| [#5](https://git.notsosm.art/david/Mainline/issues/5) | Real-Time Input (Sensors) | [#15](https://git.notsosm.art/david/Mainline/issues/15), [#16](https://git.notsosm.art/david/Mainline/issues/16) | ✅ Done |
| [#6](https://git.notsosm.art/david/Mainline/issues/6) | Effects Plugin System | [#17](https://git.notsosm.art/david/Mainline/issues/17), [#18](https://git.notsosm.art/david/Mainline/issues/18) | ✅ Done |
## Incomplete Work
| Issue | Title | Status |
|-------|-------|--------|
| [#19](https://git.notsosm.art/david/Mainline/issues/19) | Legacy Cleanup Phase 5 | ⏳ Not Started |
## Story Summary
- **Total Stories:** 12
- **Completed:** 11
- **Incomplete:** 1 (Legacy cleanup)
## Quick Links
- [Home](Home) | [ADR Index](ADR-Index) | [Issues](https://git.notsosm.art/david/Mainline/issues)

@@ -2,6 +2,12 @@
Welcome to the Mainline project wiki. Welcome to the Mainline project wiki.
## Quick Navigation
- [ADR Index](ADR-Index) - Architecture decisions
- [Epics](Epics) - Feature areas and stories
- [Issues](https://git.notsosm.art/david/Mainline/issues) - Task tracking
## Architecture Decision Records (ADRs) ## Architecture Decision Records (ADRs)
ADRs document the "why" behind our architectural choices. See [Michael Nygard's post](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions) for the origin of this practice. ADRs document the "why" behind our architectural choices. See [Michael Nygard's post](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions) for the origin of this practice.
@@ -15,7 +21,7 @@ ADRs document the "why" behind our architectural choices. See [Michael Nygard's
| [ADR-005](ADR-005-Sensor-Framework) | Sensor Framework | Real-time input (mic, metrics) driving effect parameters | | [ADR-005](ADR-005-Sensor-Framework) | Sensor Framework | Real-time input (mic, metrics) driving effect parameters |
| [ADR-006](ADR-006-Preset-TOML-Format) | Preset TOML Format | Human-readable pipeline configuration | | [ADR-006](ADR-006-Preset-TOML-Format) | Preset TOML Format | Human-readable pipeline configuration |
## Quick Links ## External Links
- [Main Repository](https://git.notsosm.art/david/Mainline) - [Main Repository](https://git.notsosm.art/david/Mainline)
- [Issue Tracker](https://git.notsosm.art/david/Mainline/issues) - [Issue Tracker](https://git.notsosm.art/david/Mainline/issues)