Skip to content

Commit 2dbf7ea

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

3 files changed

Lines changed: 122 additions & 4 deletions

File tree

‎README.adoc‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,3 +230,8 @@ Your knowledge is yours. The code to manage it should be too.
230230
* https://rescript-lang.org/[ReScript] - Type-safe language compiling to JS
231231
* https://tauri.app/[Tauri] - Cross-platform app framework
232232
* https://github.com/hyperpolymath[hyperpolymath] ecosystem - ReScript-TEA, rescript-tauri, bunsenite
233+
234+
235+
== Architecture
236+
237+
See link:TOPOLOGY.md[TOPOLOGY.md] for a visual architecture map and completion dashboard.

‎TOPOLOGY.md‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
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+
# Nexia — Project Topology
6+
7+
## System Architecture
8+
9+
```
10+
┌─────────────────────────────────────────┐
11+
│ USER INTERFACE │
12+
│ (Spatial Canvas / Notes) │
13+
└───────────────────┬─────────────────────┘
14+
│
15+
▼
16+
┌─────────────────────────────────────────┐
17+
│ UI LAYER (RESCRIPT) │
18+
│ (TEA Architecture, cadre-tea-router) │
19+
└──────────┬───────────────────┬──────────┘
20+
│ │
21+
▼ ▼
22+
┌───────────────────┐ ┌───────────────────┐
23+
│ TAURI SHELL │ │ BROWSER / PWA │
24+
│ (Desktop/Mobile) │ │ (WASM/JS) │
25+
└──────────┬────────┘ └──────────┬────────┘
26+
│ │
27+
└──────────┬───────────┘
28+
│
29+
▼
30+
┌─────────────────────────────────────────┐
31+
│ RUST CORE (CRATES) │
32+
│ │
33+
│ ┌───────────┐ ┌───────────────────┐ │
34+
│ │ Graph │ │ Search │ │
35+
│ │ (Petgraph)│ │ (Tantivy) │ │
36+
│ └─────┬─────┘ └────────┬──────────┘ │
37+
│ │ │ │
38+
│ ┌─────▼─────┐ ┌────────▼──────────┐ │
39+
│ │ Storage │ │ Nickel │ │
40+
│ │ (FS/IDB) │ │ Schemas │ │
41+
│ └─────┬─────┘ └────────┬──────────┘ │
42+
└────────│─────────────────│──────────────┘
43+
│ │
44+
▼ ▼
45+
┌─────────────────────────────────────────┐
46+
│ DATA LAYER │
47+
│ ┌───────────┐ ┌───────────────────┐ │
48+
│ │ Local JSON│ │ IndexedDB │ │
49+
│ │ (Files) │ │ (Web Storage) │ │
50+
│ └───────────┘ └───────────────────┘ │
51+
└─────────────────────────────────────────┘
52+
53+
┌─────────────────────────────────────────┐
54+
│ REPO INFRASTRUCTURE │
55+
│ Justfile Automation .machine_readable/ │
56+
│ Deno Tooling 0-AI-MANIFEST.a2ml │
57+
└─────────────────────────────────────────┘
58+
```
59+
60+
## Completion Dashboard
61+
62+
```
63+
COMPONENT STATUS NOTES
64+
───────────────────────────────── ────────────────── ─────────────────────────────────
65+
USER INTERFACES
66+
ReScript UI (TEA) ██████░░░░ 60% Spatial canvas prototyping
67+
Tauri Desktop Shell ████████░░ 80% Linux/macOS integration verified
68+
Tauri Mobile Shell ████░░░░░░ 40% Initial Android stubs
69+
Web / PWA Deployment ██████░░░░ 60% Offline service worker verified
70+
71+
CORE ENGINE (RUST)
72+
Graph Engine (petgraph) ██████████ 100% Bidirectional links stable
73+
Search Indexing (tantivy) ████████░░ 80% FTS integration refining
74+
File I/O (JSON/XML) ██████████ 100% Local-first storage verified
75+
Nickel Schemas ██████████ 100% Note validation active
76+
77+
REPO INFRASTRUCTURE
78+
Justfile Automation ██████████ 100% Standard build/setup tasks
79+
.machine_readable/ ██████████ 100% STATE tracking active
80+
Deno Task Runner ██████████ 100% Package management verified
81+
82+
─────────────────────────────────────────────────────────────────────────────
83+
OVERALL: ███████░░░ ~70% Core engine stable, UI refining
84+
```
85+
86+
## Key Dependencies
87+
88+
```
89+
Nickel Schema ───► Rust Core ──────► Graph Engine ──────► Spatial UI
90+
│ │ │ │
91+
▼ ▼ ▼ ▼
92+
Storage Logic ──► Local Files ──────► Search Index ───► Query Agent
93+
```
94+
95+
## Update Protocol
96+
97+
This file is maintained by both humans and AI agents. When updating:
98+
99+
1. **After completing a component**: Change its bar and percentage
100+
2. **After adding a component**: Add a new row in the appropriate section
101+
3. **After architectural changes**: Update the ASCII diagram
102+
4. **Date**: Update the `Last updated` comment at the top of this file
103+
104+
Progress bars use: `█` (filled) and `░` (empty), 10 characters wide.
105+
Percentages: 0%, 10%, 20%, ... 100% (in 10% increments).

‎core/src/lib.rs‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,24 @@
11
// SPDX-License-Identifier: AGPL-3.0-or-later
2-
//! Nexia Core - Knowledge graph engine
2+
3+
//! Nexia Core — Knowledge Graph and Note Engine.
4+
//!
5+
//! This crate provides the foundational data structures for the Nexia
6+
//! ecosystem. It treats notes as nodes in a multi-dimensional graph,
7+
//! supporting bidirectional linking and spatial arrangement.
38
//!
4-
//! This crate provides the core data structures and operations for Nexia,
5-
//! a cross-platform personal knowledge management tool.
9+
//! ARCHITECTURE:
10+
//! - `note`: Individual atomic unit of information.
11+
//! - `notebook`: A logical collection/subgraph of notes.
12+
//! - `storage`: Content-addressable persistence layer.
613
714
pub mod note;
815
pub mod notebook;
916
pub mod storage;
1017

18+
// PUBLIC API: Re-export primary types for use in Desktop (Tauri) and Web consumers.
1119
pub use note::{Note, NoteId, Point2D};
1220
pub use notebook::Notebook;
1321
pub use storage::Storage;
1422

15-
/// Library version
23+
/// Crate version from Cargo metadata.
1624
pub const VERSION: &str = env!("CARGO_PKG_VERSION");

0 commit comments

Comments
 (0)