docs: restructure bootstrap, add module references, and normalize docs

This commit is contained in:
Scott Idem
2026-06-12 16:48:35 -04:00
parent e05602b87b
commit a227c6aaa7
11 changed files with 511 additions and 237 deletions

View File

@@ -0,0 +1,51 @@
# Aether Journals — Module Overview
**Status:** Active module
**Library:** `src/lib/ae_journals/`
**Routes:** `src/routes/journals/`
This module manages private personal journals and journal entries with offline-first behavior and Svelte 5 runes patterns.
---
## Core Responsibilities
- Journal and journal-entry CRUD via V3 API wrappers.
- Dexie-backed local cache with liveQuery-driven UI updates.
- Private/passcode-aware access behavior.
- Entry editing flows including auto-save configuration.
---
## Key Data Objects
- `journal`
- `journal_entry`
Common fields and behavior follow Aether object conventions (`code`, `name`, `enable`, `hide`, `priority`, `sort`, `cfg_json`, `data_json`).
---
## Storage and Reactivity
- Local cache: Dexie tables in journals DB layer.
- UI reactivity: Svelte 5 runes (`$state`, `$derived`, `$effect`) plus liveQuery wrappers (`lq__*`, `lqw__*`).
- Persisted module settings: see config map.
Related config map:
- `documentation/MODULE__AE_Journals_Config_Map.md`
---
## Access and Privacy
Journals contain private personal data. Treat all journal and journal-entry routes as authenticated/private content.
---
## Related Docs
- `documentation/PROJECT__AE_UI_Journals_module_update_2026.md`
- `documentation/GUIDE__SvelteKit2_Svelte5_DexieJS.md`
- `documentation/GUIDE__AE_API_V3_for_Frontend.md`
- `documentation/BOOTSTRAP__AI_Agent_Quickstart.md`