Skip to content

Commit bf4540b

Browse files
author
Jonathan D.A. Jewell
committed
Auto-commit: Sync changes [2026-02-21]
1 parent b5efe4b commit bf4540b

File tree

2 files changed

+108
-0
lines changed

2 files changed

+108
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,8 @@ image:https://img.shields.io/badge/Philosophy-Palimpsest-indigo.svg[Palimpsest,l
99

1010

1111
Cross-platform document editor with format tabs (TXT/MD/ADOC/DJOT/ORG/RST/TYP). Tauri 2.0 GUI + Ada TUI. Graph visualization, OCR, TTS/STT, Nickel pipelines.
12+
13+
14+
## Architecture
15+
16+
See [TOPOLOGY.md](TOPOLOGY.md) for a visual architecture map and completion dashboard.

TOPOLOGY.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
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+
# DocMatrix (formatrix-docs) — Project Topology
6+
7+
## System Architecture
8+
9+
```
10+
┌─────────────────────────────────────────┐
11+
│ USER INTERFACE │
12+
│ (GUI / TUI / CLI) │
13+
└──────────┬───────────────────┬──────────┘
14+
│ │
15+
▼ ▼
16+
┌───────────────────┐ ┌───────────────────┐
17+
│ GUI (TAURI 2.0) │ │ TUI (ADA) │
18+
│ (ReScript / React)│ │ (AdaCurses) │
19+
└──────────┬────────┘ └──────────┬────────┘
20+
│ │
21+
└──────────┬───────────┘
22+
23+
24+
┌─────────────────────────────────────────┐
25+
│ RUST CORE (CRATES) │
26+
│ │
27+
│ ┌───────────┐ ┌───────────────────┐ │
28+
│ │ AST / │ │ Nickel │ │
29+
│ │ Parsers │ │ Pipelines │ │
30+
│ └─────┬─────┘ └────────┬──────────┘ │
31+
│ │ │ │
32+
│ ┌─────▼─────┐ ┌────────▼──────────┐ │
33+
│ │ ArangoDB │ │ OCR / TTS │ │
34+
│ │ Client │ │ Services │ │
35+
│ └─────┬─────┘ └────────┬──────────┘ │
36+
└────────│─────────────────│──────────────┘
37+
│ │
38+
▼ ▼
39+
┌─────────────────────────────────────────┐
40+
│ DATA LAYER │
41+
│ ┌───────────┐ ┌───────────────────┐ │
42+
│ │ ArangoDB │ │ Filesystem │ │
43+
│ │ (Graph) │ │ (MD/ADOC/ORG/etc) │ │
44+
│ └───────────┘ └───────────────────┘ │
45+
└─────────────────────────────────────────┘
46+
47+
┌─────────────────────────────────────────┐
48+
│ REPO INFRASTRUCTURE │
49+
│ Justfile .machine_readable/ │
50+
│ Wolfi Containers RSR Tier 2 │
51+
└─────────────────────────────────────────┘
52+
```
53+
54+
## Completion Dashboard
55+
56+
```
57+
COMPONENT STATUS NOTES
58+
───────────────────────────────── ────────────────── ─────────────────────────────────
59+
CORE ENGINE (RUST)
60+
Unified AST ██████████ 100% Lossless conversion stable
61+
Format Parsers (MD/ADOC/etc) ████████░░ 80% Typst parser refining
62+
Nickel Pipeline Executor ██████████ 100% Transformations active
63+
ArangoDB Client ██████████ 100% Document persistence stable
64+
65+
USER INTERFACES
66+
Tauri 2.0 GUI ████████░░ 80% ReScript UI components active
67+
Ada TUI (AdaCurses) ██████░░░░ 60% Layout logic in progress
68+
Graph Visualization ████░░░░░░ 40% Initial D3.js prototyping
69+
70+
SERVICES & ACCESSIBILITY
71+
OCR Integration ██████░░░░ 60% Tesseract bindings active
72+
TTS / STT Support ████░░░░░░ 40% Initial engine integration
73+
Nickel Import/Export ██████████ 100% Standard pipelines verified
74+
75+
REPO INFRASTRUCTURE
76+
Justfile ██████████ 100% Full multi-language build
77+
.machine_readable/ ██████████ 100% STATE.a2ml tracking
78+
Wolfi Containers ██████████ 100% Reproducible build env
79+
80+
─────────────────────────────────────────────────────────────────────────────
81+
OVERALL: ████████░░ ~80% Core engine stable, UI refining
82+
```
83+
84+
## Key Dependencies
85+
86+
```
87+
Nickel Pipeline ───► Rust Parser ───► Unified AST ───► Renderers
88+
│ │ │
89+
▼ ▼ ▼
90+
ArangoDB ────────► Tauri / Ada ─────► User UI
91+
```
92+
93+
## Update Protocol
94+
95+
This file is maintained by both humans and AI agents. When updating:
96+
97+
1. **After completing a component**: Change its bar and percentage
98+
2. **After adding a component**: Add a new row in the appropriate section
99+
3. **After architectural changes**: Update the ASCII diagram
100+
4. **Date**: Update the `Last updated` comment at the top of this file
101+
102+
Progress bars use: `` (filled) and `` (empty), 10 characters wide.
103+
Percentages: 0%, 10%, 20%, ... 100% (in 10% increments).

0 commit comments

Comments
 (0)