docs: seventh-pass archive unsafe legacy references

This commit is contained in:
Scott Idem
2026-06-12 17:07:03 -04:00
parent e6fb4b289f
commit 75e7ca541a
12 changed files with 61 additions and 17 deletions

View File

@@ -1,5 +1,7 @@
# Aether Project Architecture # Aether Project Architecture
**Last Updated:** 2026-06-12
This document outlines the overall architecture and key technologies used in the Aether SvelteKit frontend project. This document outlines the overall architecture and key technologies used in the Aether SvelteKit frontend project.
## 1. Project Overview ## 1. Project Overview
@@ -20,7 +22,7 @@ The Aether project is a Svelte and SvelteKit based application, utilizing Tailwi
- TipTap (`element_editor_tiptap.svelte`) — WYSIWYG rich-text for content fields (IDAA, Journals, Leads notes) - TipTap (`element_editor_tiptap.svelte`) — WYSIWYG rich-text for content fields (IDAA, Journals, Leads notes)
- **Icons:** Lucide Icons (SVG Icons) - **Icons:** Lucide Icons (SVG Icons)
- **Markdown Parsing:** `marked` library - **Markdown Parsing:** `marked` library
- **State Management:** Svelte stores, potentially with `liveQuery` from Dexie for reactive IndexedDB interactions. - **State Management:** Svelte 5 runes plus Dexie `liveQuery`. Events persisted state uses `runed` `PersistedState`; core and IDAA still contain legacy coarse-grained persisted stores pending migration.
### 2.1. Journals as the Canonical Frontend Pattern ### 2.1. Journals as the Canonical Frontend Pattern
@@ -78,8 +80,8 @@ Used for client-side persistence of various application states and configuration
Used for more structured client-side data storage, often for caching and offline capabilities. Used for more structured client-side data storage, often for caching and offline capabilities.
- `ae_core_db`: Core database instance. - `db_core`: Core database instance.
- `<module>`: Module-specific database instances. - `db_<module>`: Module-specific database instances (for example, `db_events` and `db_journals`).
- `<custom>`: Custom module-specific database instances (none currently defined). - `<custom>`: Custom module-specific database instances (none currently defined).
## 5. Data Sorting ## 5. Data Sorting
@@ -97,9 +99,9 @@ A set of standardized field names and types are used across Aether objects.
These fields are expected to be present in most Aether objects. These fields are expected to be present in most Aether objects.
- `id`: Primary key for an object (internal use, often a UUID). - `<object_type>_id`: Canonical randomized string ID returned by V3 (for example, `person_id`). Use this for URLs, relationships, and Dexie indexed lookups.
- `id_random`: Randomly generated ID for an object (often used for external exposure or URL parameters). - `id`: Generic randomized string alias when returned by V3; do not assume it is a DB autonumber.
- `<object_type>_id_random`: Specific random ID for an object (e.g., `person_id_random`). - `id_random` / `<object_type>_id_random`: Legacy aliases. Do not introduce new usage.
- `code`: Short, unique identifier. - `code`: Short, unique identifier.
- `name`: Display name. - `name`: Display name.
- `enable`: Boolean for active/inactive status. - `enable`: Boolean for active/inactive status.

View File

@@ -1,5 +1,7 @@
# Aether Project Naming Conventions # Aether Project Naming Conventions
**Last Updated:** 2026-06-12
## 1. General Principles ## 1. General Principles
- **Clarity:** Names should clearly convey their purpose and meaning. - **Clarity:** Names should clearly convey their purpose and meaning.
@@ -11,9 +13,10 @@
- **Logic/Service Files:** `ae_<module>__<concept>.ts` (e.g., `ae_core__account.ts`, `ae_events__event.ts`) - **Logic/Service Files:** `ae_<module>__<concept>.ts` (e.g., `ae_core__account.ts`, `ae_events__event.ts`)
- **Database Definition Files:** `db_<module>.ts` (e.g., `db_core.ts`, `db_journals.ts`) - **Database Definition Files:** `db_<module>.ts` (e.g., `db_core.ts`, `db_journals.ts`)
- **Svelte Store Files:** `ae_<module>_stores.ts` (e.g., `ae_core_stores.ts`, `ae_journals_stores.ts`) - **Svelte Store Files:** Follow existing module names. Svelte 5 `PersistedState` files use a `.svelte.ts` suffix and are imported via the `.svelte` module path (for example, `ae_events_stores__badges.svelte.ts`).
- **Svelte Components:** - **Svelte Components:**
- **Module-specific components:** `ae_comp__<module>__<component_name>.svelte` (e.g., `ae_comp__events__event_card.svelte`) - **Route-level components:** `ae_comp__<component_name>.svelte`.
- **Module-specific components:** `ae_<module>_comp__<component_name>.svelte` (for example, `ae_events_comp__session_list.svelte`).
- **Generic/reusable components:** `element_<component_name>.svelte` (e.g., `element_input_file.svelte`, `element_qr_scanner_v2.svelte`) - **Generic/reusable components:** `element_<component_name>.svelte` (e.g., `element_input_file.svelte`, `element_qr_scanner_v2.svelte`)
- **SvelteKit Routes:** Follow SvelteKit's standard routing conventions (e.g., `+page.svelte`, `+layout.svelte`, `[id]/+page.svelte`). - **SvelteKit Routes:** Follow SvelteKit's standard routing conventions (e.g., `+page.svelte`, `+layout.svelte`, `[id]/+page.svelte`).
- **CSS Files:** `ae-<module>-<purpose>.css` (e.g., `ae-c-idaa-light.css`, `ae-osit-default.css`) - **CSS Files:** `ae-<module>-<purpose>.css` (e.g., `ae-c-idaa-light.css`, `ae-osit-default.css`)
@@ -37,9 +40,9 @@
- **Singularity:** Use singular nouns for objects and properties (e.g., `example.id`, not `examples.id`). - **Singularity:** Use singular nouns for objects and properties (e.g., `example.id`, not `examples.id`).
- **IDs:** - **IDs:**
- `id`: Primary key for an object (internal use, often a UUID). - `<object_type>_id`: Canonical randomized string ID returned by V3 (for example, `person_id`).
- `<object_type>_id`: Specific ID for an object (e.g., `person_id`). - `id`: Generic randomized string alias when V3 returns one; never assume it is an integer autonumber.
- `<object_type>_id_random`: Randomly generated ID for an object (often used for external exposure or URL parameters). - `<object_type>_id_random`: Legacy alias; do not introduce new usage.
- `account_id`, `site_id`, `user_id`, etc.: Foreign keys. - `account_id`, `site_id`, `user_id`, etc.: Foreign keys.
- **Common Properties:** - **Common Properties:**
- `code`: Short, unique identifier. - `code`: Short, unique identifier.
@@ -88,6 +91,6 @@
- `<module>` (extended modules) - `<module>` (extended modules)
- `<custom>` (custom modules) - `<custom>` (custom modules)
- **IndexedDB:** - **IndexedDB:**
- `ae_core_db` - `db_core`
- `<module>` - `db_<module>` (for example, `db_events`, `db_journals`)
- `<custom>` - `<custom>`

View File

@@ -1,6 +1,6 @@
# Aether — Permissions and Security # Aether — Permissions and Security
**Last updated:** 2026-02-27 **Last Updated:** 2026-02-27
**Source of truth:** `src/lib/ae_utils/ae_utils__perm_checks.ts`, `src/lib/stores/ae_stores.ts` **Source of truth:** `src/lib/ae_utils/ae_utils__perm_checks.ts`, `src/lib/stores/ae_stores.ts`
--- ---

View File

@@ -3,7 +3,7 @@
> **Last Updated:** 2026-03-20 > **Last Updated:** 2026-03-20
> **Author:** One Sky IT / Scott Idem > **Author:** One Sky IT / Scott Idem
> **Scope:** All Aether SvelteKit frontend components > **Scope:** All Aether SvelteKit frontend components
> **Related:** `AE__UI_Component_Patterns.md`, `ae-firefly.css`, `documentation/AE__Components.md` > **Related:** `ae-firefly.css`, `documentation/MODULE__AE_Journals.md`, `documentation/MODULE__AE_Events_Presentation_Management.md`
> **Historical implementation log:** `documentation/archive/PROJECT__AE_Style_Review_2026-03.md` > **Historical implementation log:** `documentation/archive/PROJECT__AE_Style_Review_2026-03.md`
--- ---

View File

@@ -44,6 +44,9 @@ Do not delete historical context; move to `documentation/archive/` with clear na
- Validated all `documentation/*.md` references in active docs; no missing targets remain. - Validated all `documentation/*.md` references in active docs; no missing targets remain.
- Added ownership and review-trigger metadata to the bootstrap, task list, and docs index. - Added ownership and review-trigger metadata to the bootstrap, task list, and docs index.
- Reviewed active project docs for archive eligibility. Object Field Editor and Site Passcode Security remain active and were added to the docs index. - Reviewed active project docs for archive eligibility. Object Field Editor and Site Passcode Security remain active and were added to the docs index.
- Archived legacy API-object, component-inventory, data-structure, performance, and UI-pattern references that contradicted V3 IDs, Svelte 5, or current private-route execution rules.
- Refreshed `AE__Architecture.md` and `AE__Naming_Conventions.md` as the active replacements.
- Added `documentation/archive/README.md` to explain archive categories and restoration policy.
### Next archive candidates (review + approve) ### Next archive candidates (review + approve)
- Older style-review snapshots once current style guide references are centralized. - Older style-review snapshots once current style guide references are centralized.
@@ -61,6 +64,6 @@ Monthly lightweight review:
## 5) Immediate Follow-Up Tasks ## 5) Immediate Follow-Up Tasks
1. Run a quarterly archive review: identify stale `PROJECT__` docs with no TODO or index linkage and move them to `documentation/archive/`. 1. Run a quarterly archive review: identify stale `PROJECT__` docs with no TODO or index linkage and move them to `documentation/archive/`.
2. Review `AE__*` reference docs for overlap, outdated stack assumptions, and inconsistent naming. 2. Review remaining `AE__*` docs (`Permissions`, Docker policy, and UI future ideas) against current source and decide whether each remains active reference or proposal material.
3. Review module docs against current routes and store names rather than relying only on filename/header freshness. 3. Review module docs against current routes and store names rather than relying only on filename/header freshness.
4. Add a lightweight reusable link-check script if manual path validation becomes frequent. 4. Add a lightweight reusable link-check script if manual path validation becomes frequent.

View File

@@ -20,6 +20,7 @@ Use this file as the routing map for project documentation.
## 3) Safety and Reference ## 3) Safety and Reference
- `documentation/AE__Architecture.md`
- `documentation/AE__Permissions_and_Security.md` - `documentation/AE__Permissions_and_Security.md`
- `documentation/REFERENCE__Common_Agent_Mistakes.md` - `documentation/REFERENCE__Common_Agent_Mistakes.md`
- `documentation/AE__Naming_Conventions.md` - `documentation/AE__Naming_Conventions.md`
@@ -60,6 +61,7 @@ Use this file as the routing map for project documentation.
## 6) Archive ## 6) Archive
- `documentation/archive/` - `documentation/archive/README.md`
Archive contains completed historical project notes and superseded proposals. Archive contains completed historical project notes and superseded proposals.
Legacy API-object, component-inventory, data-structure, performance, and UI-pattern snapshots are archived because they describe pre-V3 or pre-runes behavior. Use the active V3, Dexie, style, architecture, and module docs instead.

View File

@@ -0,0 +1,34 @@
# Documentation Archive Index
This directory preserves completed projects, superseded proposals, historical task logs, and legacy technical references.
Archived files are not authoritative for current implementation. Start with `documentation/README__Docs_Index.md` and the active module/guides directory.
## Categories
### Completed or Superseded Projects
Files prefixed with `PROJECT__` document completed implementation phases or superseded project plans.
### Historical Proposals
Files prefixed with `PROPOSAL__` preserve design ideas that are not the current implementation source.
### Task History
Files prefixed with `TODO__Agents__ARCHIVE_` contain completed task history by month.
### Legacy References
Files prefixed with `REFERENCE__Legacy_` are retained for historical context but contain pre-V3, pre-runes, or otherwise superseded guidance.
Do not copy implementation patterns from legacy references without validating them against current source and active guides.
## Restore Policy
Move an archived doc back to the active documentation root only when:
1. Its subject is active again.
2. Its content has been reviewed against current source.
3. Legacy paths, IDs, stores, and API conventions have been updated.
4. It is added to `documentation/README__Docs_Index.md`.