From e6fb4b289fa08c7ed8684b97fa61c1cda5971194 Mon Sep 17 00:00:00 2001 From: Scott Idem Date: Fri, 12 Jun 2026 17:05:13 -0400 Subject: [PATCH] docs: sixth-pass project routing and link validation --- documentation/BOOTSTRAP__AI_Agent_Quickstart.md | 3 ++- documentation/GUIDE__AE_UI_Style_Guidelines.md | 1 + documentation/GUIDE__Development.md | 3 ++- .../PROJECT__AE_Object_Field_Editor_V3_upgrade.md | 3 ++- documentation/PROJECT__AE_Site_Passcode_Security.md | 2 +- ...CT__Documentation_Refresh_and_Archive_Plan_2026.md | 11 +++++++---- documentation/PROJECT__Stores_Svelte5_Migration.md | 3 ++- documentation/README__Docs_Index.md | 3 +++ documentation/TODO__Agents.md | 1 + 9 files changed, 21 insertions(+), 9 deletions(-) diff --git a/documentation/BOOTSTRAP__AI_Agent_Quickstart.md b/documentation/BOOTSTRAP__AI_Agent_Quickstart.md index 6d2d3f7c..bb17c367 100644 --- a/documentation/BOOTSTRAP__AI_Agent_Quickstart.md +++ b/documentation/BOOTSTRAP__AI_Agent_Quickstart.md @@ -1,5 +1,6 @@ # Aether SvelteKit — AI Agent Bootstrap / Quickstart > **Doc Owner:** Frontend platform maintainers (OSIT) + active coding agents +> **Review Trigger:** Update when module architecture, critical rules, or primary doc paths change. > **Read this first.** This doc is the fast path to being productive on this project. > It covers the rules, patterns, and gotchas that matter most. > Deep dives are in the linked docs at the bottom. @@ -346,7 +347,7 @@ Start here, then go deeper as needed: | Common mistakes reference | `documentation/REFERENCE__Common_Agent_Mistakes.md` | | Svelte 5 patterns + pitfalls | `documentation/GEMINI__Svelte_and_Me.md` | | Permissions + auth levels | `documentation/AE__Permissions_and_Security.md` | -| Electron / native launcher | `documentation/PROJECT__AE_Events_Launcher_Native_integration.md` | +| Electron / native launcher | `documentation/MODULE__AE_Events_Launcher_Native.md` | | Store migration plan | `documentation/PROJECT__Stores_Svelte5_Migration.md` | | Journals module overview | `documentation/MODULE__AE_Journals.md` | | Journals settings map | `documentation/MODULE__AE_Journals_Config_Map.md` | diff --git a/documentation/GUIDE__AE_UI_Style_Guidelines.md b/documentation/GUIDE__AE_UI_Style_Guidelines.md index 0a916b22..768e410a 100644 --- a/documentation/GUIDE__AE_UI_Style_Guidelines.md +++ b/documentation/GUIDE__AE_UI_Style_Guidelines.md @@ -1,5 +1,6 @@ # Aether UI — Design System Style Guidelines > **Version:** 1.2 (2026-03-20) +> **Last Updated:** 2026-03-20 > **Author:** One Sky IT / Scott Idem > **Scope:** All Aether SvelteKit frontend components > **Related:** `AE__UI_Component_Patterns.md`, `ae-firefly.css`, `documentation/AE__Components.md` diff --git a/documentation/GUIDE__Development.md b/documentation/GUIDE__Development.md index 2e68c820..e19b3ec4 100644 --- a/documentation/GUIDE__Development.md +++ b/documentation/GUIDE__Development.md @@ -1,5 +1,6 @@ # Aether Development SOP (Frontend) > **Version:** 1.2 (2026-03-17) +> **Last Updated:** 2026-03-17 > **Location:** documentation/GUIDE__Development.md ## 1. Verification (The "Test-First" Mandate) @@ -50,7 +51,7 @@ You are not working in a vacuum. Coordinate with the Backend Agent via MCP tools | `documentation/GEMINI__Svelte_and_Me.md` | Svelte 5 runes patterns | | `documentation/AE__Architecture.md` | System architecture overview | | `documentation/AE__Naming_Conventions.md` | Naming rules | -| `documentation/PROJECT__AE_Events_Launcher_Native_integration.md` | Electron/Launcher reference | +| `documentation/MODULE__AE_Events_Launcher_Native.md` | Electron/Launcher reference | | `tests/README.md` | Playwright test guide — shared helpers, hard-won lessons, demo IDs | ## 6. Inline Field Editing — `element_ae_obj_field_editor` diff --git a/documentation/PROJECT__AE_Object_Field_Editor_V3_upgrade.md b/documentation/PROJECT__AE_Object_Field_Editor_V3_upgrade.md index 7b615c8f..30579324 100644 --- a/documentation/PROJECT__AE_Object_Field_Editor_V3_upgrade.md +++ b/documentation/PROJECT__AE_Object_Field_Editor_V3_upgrade.md @@ -1,7 +1,8 @@ # Project Plan: Aether AE Obj Field Editor v3 (Consolidated) > **Status:** 🟡 Mostly Complete — Phase 3 items + GUIDE update remaining -> **Date:** February 13, 2026 (last updated: 2026-03-20) +> **Created:** 2026-02-13 +> **Last Updated:** 2026-03-20 > **Target Component:** `src/lib/elements/element_ae_obj_field_editor.svelte` > **Replaces:** `element_ae_crud.svelte` and `element_ae_crud_v2.svelte` diff --git a/documentation/PROJECT__AE_Site_Passcode_Security.md b/documentation/PROJECT__AE_Site_Passcode_Security.md index 1edb6945..8be3af4d 100644 --- a/documentation/PROJECT__AE_Site_Passcode_Security.md +++ b/documentation/PROJECT__AE_Site_Passcode_Security.md @@ -1,6 +1,6 @@ # PROJECT: Site Passcode Security — API-Verified Auth -**Last updated:** 2026-04-10 +**Last Updated:** 2026-04-10 **Status:** Backend work in progress — frontend pending backend completion **Priority:** High — passcodes for trusted/administrator access currently in localStorage plaintext diff --git a/documentation/PROJECT__Documentation_Refresh_and_Archive_Plan_2026.md b/documentation/PROJECT__Documentation_Refresh_and_Archive_Plan_2026.md index 5fbb2812..291d4c14 100644 --- a/documentation/PROJECT__Documentation_Refresh_and_Archive_Plan_2026.md +++ b/documentation/PROJECT__Documentation_Refresh_and_Archive_Plan_2026.md @@ -41,6 +41,9 @@ Do not delete historical context; move to `documentation/archive/` with clear na - Renamed `AE_Docker_CI_cache_policy.md` -> `AE__Docker_CI_Cache_Policy.md`. - Archived `PROJECT__AE_Style_Review.md` -> `archive/PROJECT__AE_Style_Review_2026-03.md` (active style source is `GUIDE__AE_UI_Style_Guidelines.md`). - Clarified scope split: `GUIDE__AE_Events_Badges_Onsite.md` = deep badge-print reference, `GUIDE__AE_Events_Onsite_Runbook.md` = cross-module onsite operations runbook. +- 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. +- Reviewed active project docs for archive eligibility. Object Field Editor and Site Passcode Security remain active and were added to the docs index. ### Next archive candidates (review + approve) - Older style-review snapshots once current style guide references are centralized. @@ -57,7 +60,7 @@ Monthly lightweight review: ## 5) Immediate Follow-Up Tasks -1. Add `Last Updated` metadata lines to remaining active docs that still only encode dates via `Version` or legacy `Last updated` casing. -2. Promote one consistent `Last Updated` format (`**Last Updated:** YYYY-MM-DD`) across all active docs. -3. Run a quarterly archive review: identify stale `PROJECT__` docs with no TODO linkage and move to `documentation/archive/`. -4. Add a short "Review Trigger" line to high-churn docs (for example, "update after any commit that renames docs or changes module routes"). +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. +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. diff --git a/documentation/PROJECT__Stores_Svelte5_Migration.md b/documentation/PROJECT__Stores_Svelte5_Migration.md index e38c2e0d..17532187 100644 --- a/documentation/PROJECT__Stores_Svelte5_Migration.md +++ b/documentation/PROJECT__Stores_Svelte5_Migration.md @@ -2,7 +2,8 @@ **Status:** Events module — COMPLETE. Core / IDAA — In Progress (field cleanup done, PersistedState pending). **Priority:** High -**Created:** 2026-03-30 | **Last updated:** 2026-06-11 +**Created:** 2026-03-30 +**Last Updated:** 2026-06-11 --- diff --git a/documentation/README__Docs_Index.md b/documentation/README__Docs_Index.md index fc839568..147d3ff5 100644 --- a/documentation/README__Docs_Index.md +++ b/documentation/README__Docs_Index.md @@ -1,6 +1,7 @@ # Aether SvelteKit — Documentation Index **Doc Owner:** Frontend platform maintainers (OSIT) +**Review Trigger:** Update whenever a documentation file is added, renamed, archived, or restored. Use this file as the routing map for project documentation. @@ -54,6 +55,8 @@ Use this file as the routing map for project documentation. - `documentation/PROJECT__AE_Events_PressMgmt_Config_Cleanup.md` - `documentation/PROJECT__AE_Events_Badges_Review_Print.md` - `documentation/PROJECT__AE_UI_Journals_Module_Update_2026.md` +- `documentation/PROJECT__AE_Object_Field_Editor_V3_upgrade.md` +- `documentation/PROJECT__AE_Site_Passcode_Security.md` ## 6) Archive diff --git a/documentation/TODO__Agents.md b/documentation/TODO__Agents.md index 2b775925..3bf3393c 100644 --- a/documentation/TODO__Agents.md +++ b/documentation/TODO__Agents.md @@ -1,5 +1,6 @@ # Frontend Agent Task List > **Doc Owner:** Active frontend implementation team (human + agent) +> **Review Trigger:** Update when work starts, completes, changes priority, or moves to an archive. > Use this file to track steps for complex features or bug fixes. > **Status:** Stable — ongoing development. > **Scope:** Active/open work only. Completed detail lives in archive files.