From 9da3e5326bfd13b5fcd465bfb10f9c224a0cca37 Mon Sep 17 00:00:00 2001 From: Scott Idem Date: Thu, 26 Feb 2026 10:49:23 -0500 Subject: [PATCH] docs: reorganize and rename documentation files for consistency - Apply consistent prefix naming: AE__, GUIDE__, PROJECT__, MODULE__, TODO__ - Move superseded/session docs to documentation/history/ - Migrate old/ directory contents to history/ with updated naming - README.md: replace stale Modules section with accurate current routes Co-Authored-By: Claude Sonnet 4.6 --- README.md | 132 ++++++++++++++---- ...I_OBJECTS.md => AE__Aether_API_objects.md} | 0 .../{ARCHITECTURE.md => AE__Architecture.md} | 0 .../{COMPONENTS.md => AE__Components.md} | 0 ...A_STRUCTURES.md => AE__Data_Structures.md} | 0 ...NVENTIONS.md => AE__Naming_Conventions.md} | 0 ...LINES.md => AE__Performance_Guidelines.md} | 0 ...lte_and_Me.md => GEMINI__Svelte_and_Me.md} | 0 ...PI.md => GUIDE__AE_API_V3_for_Frontend.md} | 0 ...__DEVELOPMENT.md => GUIDE__Development.md} | 7 +- ...d => GUIDE__SvelteKit2_Svelte5_DexieJS.md} | 3 + ...P.md => MODULE__AE Journals_config_map.md} | 0 ... PROJECT__AE_Events_Exhibitor_Leads_v3.md} | 0 ...T__AE_Events_Exhibitor_Leads_v3_detail.md} | 0 ..._AE_Events_Launcher_Native_integration.md} | 0 ...ECT__AE_Object_Field_Editor_V3_upgrade.md} | 2 +- ...res_Mgmt_Session_view_refactor_2026-02.md} | 0 ...ECT__AE_UI_Journals_module_update_2026.md} | 0 ...=> PROJECT__Use_AE_API_V3_CRUD_upgrade.md} | 0 .../{AGENT_TODO.md => TODO__Agents.md} | 0 ...Aether_API_CRUD_V3_beta_recommendations.md | 0 .../GEMINI_Flowbite_upgrade_2025-12.md | 0 .../GEMINI_SkeletonLabs_upgrade_2025-12.md | 0 .../{ => history}/GEMINI_debug_notes.md | 0 .../OLD__README__Guidelines_UI_UX.md} | 0 .../OLD__README__Guidelines_v1.md} | 0 .../OLD__README__Guidelines_v2.md} | 0 .../REVIEW__AE_Svelte5_performance.md} | 0 ...API_HARDENING_SESSION_REPORT_2026-01-19.md | 0 .../{ => history}/V3_FRONTEND_API_GUIDE.md | 0 30 files changed, 112 insertions(+), 32 deletions(-) rename documentation/{AETHER_API_OBJECTS.md => AE__Aether_API_objects.md} (100%) rename documentation/{ARCHITECTURE.md => AE__Architecture.md} (100%) rename documentation/{COMPONENTS.md => AE__Components.md} (100%) rename documentation/{DATA_STRUCTURES.md => AE__Data_Structures.md} (100%) rename documentation/{NAMING_CONVENTIONS.md => AE__Naming_Conventions.md} (100%) rename documentation/{PERFORMANCE_GUIDELINES.md => AE__Performance_Guidelines.md} (100%) rename documentation/{GEMINI_Svelte_and_Me.md => GEMINI__Svelte_and_Me.md} (100%) rename documentation/{GUIDE__V3_FRONTEND_API.md => GUIDE__AE_API_V3_for_Frontend.md} (100%) rename documentation/{GUIDE__DEVELOPMENT.md => GUIDE__Development.md} (90%) rename documentation/{SVELTE_DEXIE_GUIDE.md => GUIDE__SvelteKit2_Svelte5_DexieJS.md} (99%) rename documentation/{JOURNALS_CONFIG_MAP.md => MODULE__AE Journals_config_map.md} (100%) rename documentation/{Aether_Events_Exhibitor_Leads_v3.md => PROJECT__AE_Events_Exhibitor_Leads_v3.md} (100%) rename documentation/{Aether_Events_Exhibitor_Leads_v3_detail.md => PROJECT__AE_Events_Exhibitor_Leads_v3_detail.md} (100%) rename documentation/{AE_EVENTS_LAUNCHER_NATIVE_INTEGRATION.md => PROJECT__AE_Events_Launcher_Native_integration.md} (100%) rename documentation/{PROJECT_AE_OBJECT_FIELD_EDITOR_V3_UPGRADE.md => PROJECT__AE_Object_Field_Editor_V3_upgrade.md} (97%) rename documentation/{PRES_MGMT_SESSION_REFACTOR_PLAN.md => PROJECT__AE_Pres_Mgmt_Session_view_refactor_2026-02.md} (100%) rename documentation/{AE_UI_Journals_module_update_2026.md => PROJECT__AE_UI_Journals_module_update_2026.md} (100%) rename documentation/{PROJECT_CRUD_V3_UPGRADE.md => PROJECT__Use_AE_API_V3_CRUD_upgrade.md} (100%) rename documentation/{AGENT_TODO.md => TODO__Agents.md} (100%) rename documentation/{ => history}/Aether_API_CRUD_V3_beta_recommendations.md (100%) rename documentation/{ => history}/GEMINI_Flowbite_upgrade_2025-12.md (100%) rename documentation/{ => history}/GEMINI_SkeletonLabs_upgrade_2025-12.md (100%) rename documentation/{ => history}/GEMINI_debug_notes.md (100%) rename documentation/{old/OLD_README_guidelines_ui_ux.md => history/OLD__README__Guidelines_UI_UX.md} (100%) rename documentation/{old/OLD_README_guidelines_v1.md => history/OLD__README__Guidelines_v1.md} (100%) rename documentation/{old/OLD_README_guidelines_v2.md => history/OLD__README__Guidelines_v2.md} (100%) rename documentation/{AETHER_SVELTE5_PERFORMANCE_REVIEW.md => history/REVIEW__AE_Svelte5_performance.md} (100%) rename documentation/{ => history}/V3_API_HARDENING_SESSION_REPORT_2026-01-19.md (100%) rename documentation/{ => history}/V3_FRONTEND_API_GUIDE.md (100%) diff --git a/README.md b/README.md index 03aaf74d..56b6c051 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,125 @@ # One Sky IT's Aether App - SvelteKit v2 -This uses SvelteKit version 2.x with Svelte version 5.x, TailwindCSS 4.1, and Skelton. +This uses SvelteKit version 2.x with Svelte version 5.x, TailwindCSS 4.1, and Skeleton. -# Current Modules +# Modules -## AE Events - Speakers (/events_speakers) +## Core (`/core/`) -### Components +Admin-only views for foundational Aether objects. Minimal UI — primarily used for data management. -- +page.svelte - The main page for the Events - Speakers module -- 10_edit_modal\_\_event_presenter_obj.svelte - The modal for editing a presenter -- 10_list\_\_event_presenter_obj.svelte - The list of presenters/speakers -- 10_view_modal\_\_event_presenter_obj.svelte - The modal for viewing a presenter +- **Accounts** (`/core/accounts/`, `/core/accounts/[account_id]/`) +- **Activity Logs** (`/core/activity_logs/`) +- **Addresses** (`/core/addresses/`, `/core/addresses/[address_id]/`) +- **Contacts** (`/core/contacts/`, `/core/contacts/[contact_id]/`) +- **Lookups** (`/core/lookups/`) — Countries, subdivisions, time zones +- **People** (`/core/people/`, `/core/people/[person_id]/`) +- **Sites** (`/core/sites/`, `/core/sites/[site_id]/`) +- **Users** (`/core/users/`, `/core/users/[user_id]/`) -### Path [slug] +## Events (`/events/`) -- +page.svelte - The main page for the presenter ID [slug] +The primary client-facing module for conference and event management. -## AE Sponsorships (/sponsorships) +### Event List (`/events/`) -- +page.svelte - The main page for the Sponsorships module -- 10_edit_modal\_\_sponsorship_obj.svelte - The modal for editing a sponsorship -- 10_list\_\_sponsorship_obj.svelte - The list of sponsorships -- 10_view_modal\_\_sponsorship_obj.svelte - The modal for viewing a sponsorship +### Event Detail (`/events/[event_id]/`) -### Path [slug] +Each event has four sub-modules, each in its own SvelteKit route group: -- +page.svelte - The main page for the sponsorship ID [slug] +#### Presentation Management (`/(pres_mgmt)/`) -## AE Events - Exhibit Leads (/events_exhibit_leads) +Manages the full conference program. -### Components +- `/events/[event_id]/pres_mgmt/` — Dashboard +- `/events/[event_id]/locations/` — Location list +- `/events/[event_id]/location/[event_location_id]/` — Location detail +- `/events/[event_id]/presenter/[presenter_id]/` — Presenter detail +- `/events/[event_id]/session/[session_id]/` — Session detail +- `/events/[event_id]/reports/` — Presenter, session, and file reports -- +page.svelte - The main page for the Events - Exhibit Leads module -- 10_list\_\_event_exhibit_lead_obj.svelte - The list of exhibit leads -- 10_edit_modal\_\_event_exhibit_lead_obj.svelte - The modal for editing an exhibit lead -- 10_view_modal\_\_event_exhibit_lead_obj.svelte - The modal for viewing an exhibit lead +#### Launcher (`/(launcher)/`) -# Future Modules +Kiosk display system; runs on-site to show session schedules and presenter info. -## AE Events - Badges (/events_badges) +- `/events/[event_id]/launcher/` — Launcher home +- `/events/[event_id]/launcher/[event_location_id]/` — Location-specific display -- +page.svelte - The main page for the Events - Badges module -- 10_list\_\_event_badge_obj.svelte - The list of badges -- 10_view_modal\_\_event_badge_obj.svelte - The modal for viewing a badge +#### Badges (`/(badges)/`) -## AE Events - Presentation Management (/events_pres_mgmt) +Badge printing and management for event attendees. + +- `/events/[event_id]/badges/` — Badge list +- `/events/[event_id]/badges/[badge_id]/` — Badge detail +- `/events/[event_id]/badges/[badge_id]/print` — Print a single badge +- `/events/[event_id]/badges/[badge_id]/review` — Review before printing +- `/events/[event_id]/badges/print_list/` — Bulk print queue +- `/events/[event_id]/badges/stats/` — Badge statistics +- `/events/[event_id]/templates/` — Badge template management + +#### Leads (`/(leads)/`) + +Exhibitor lead capture via QR scan or manual entry. + +- `/events/[event_id]/leads/` — Exhibit list +- `/events/[event_id]/leads/exhibit/[exhibit_id]/` — Exhibit detail and lead capture +- `/events/[event_id]/leads/exhibit/[exhibit_id]/lead/[exhibit_tracking_id]/` — Lead detail + +#### Event Settings (`/settings/`) + +- `/events/[event_id]/settings/` — Event configuration (basic info, pres mgmt, badges, abstracts) + +## Journals (`/journals/`) + +The "frontier" module — most fully-featured and used as the canonical implementation reference. + +- `/journals/` — Journal list +- `/journals/[journal_id]/` — Journal detail and entry list +- `/journals/[journal_id]/entry/[journal_entry_id]/` — Journal entry detail and editor + +## IDAA (`/idaa/`) + +Custom module for the IDAA client. Built on core Aether objects (Events, Posts, Archives). + +- `/idaa/` — IDAA home / dashboard + +### Archives (`/idaa/archives/`) + +- `/idaa/archives/` — Archive list with media player +- `/idaa/archives/[archive_id]/` — Archive detail and content list + +### Bulletin Board (`/idaa/bb/`) + +Built on the Posts and Post Comments objects. + +- `/idaa/bb/` — Post list +- `/idaa/bb/[post_id]/` — Post detail and comments + +### Recovery Meetings (`/idaa/recovery_meetings/`) + +Built on the Events object. + +- `/idaa/recovery_meetings/` — Meeting list with search/filter +- `/idaa/recovery_meetings/[event_id]/` — Meeting detail + +### Video Conferences (`/idaa/video_conferences/`) + +- `/idaa/video_conferences/` — Video conference list (Jitsi integration) +- `/idaa/jitsi_reports/` — Jitsi usage reports + +## Hosted Files (`/hosted_files/`) + +- `/hosted_files/` — File list and upload management +- `/hosted_files/video_util/` — Video processing utility + +## Testing (`/testing/`) + +Developer sandbox pages — not for production use. + +- `/testing/ae_obj_field_editor_v3/` — V3 field editor playground +- `/testing/data_store_v3/` — Data store V3 playground +- `/testing/editor_test/` — CodeMirror / TipTap editor tests +- `/testing/hosted_files/` — File upload tests # How to build and deploy SvelteKit: diff --git a/documentation/AETHER_API_OBJECTS.md b/documentation/AE__Aether_API_objects.md similarity index 100% rename from documentation/AETHER_API_OBJECTS.md rename to documentation/AE__Aether_API_objects.md diff --git a/documentation/ARCHITECTURE.md b/documentation/AE__Architecture.md similarity index 100% rename from documentation/ARCHITECTURE.md rename to documentation/AE__Architecture.md diff --git a/documentation/COMPONENTS.md b/documentation/AE__Components.md similarity index 100% rename from documentation/COMPONENTS.md rename to documentation/AE__Components.md diff --git a/documentation/DATA_STRUCTURES.md b/documentation/AE__Data_Structures.md similarity index 100% rename from documentation/DATA_STRUCTURES.md rename to documentation/AE__Data_Structures.md diff --git a/documentation/NAMING_CONVENTIONS.md b/documentation/AE__Naming_Conventions.md similarity index 100% rename from documentation/NAMING_CONVENTIONS.md rename to documentation/AE__Naming_Conventions.md diff --git a/documentation/PERFORMANCE_GUIDELINES.md b/documentation/AE__Performance_Guidelines.md similarity index 100% rename from documentation/PERFORMANCE_GUIDELINES.md rename to documentation/AE__Performance_Guidelines.md diff --git a/documentation/GEMINI_Svelte_and_Me.md b/documentation/GEMINI__Svelte_and_Me.md similarity index 100% rename from documentation/GEMINI_Svelte_and_Me.md rename to documentation/GEMINI__Svelte_and_Me.md diff --git a/documentation/GUIDE__V3_FRONTEND_API.md b/documentation/GUIDE__AE_API_V3_for_Frontend.md similarity index 100% rename from documentation/GUIDE__V3_FRONTEND_API.md rename to documentation/GUIDE__AE_API_V3_for_Frontend.md diff --git a/documentation/GUIDE__DEVELOPMENT.md b/documentation/GUIDE__Development.md similarity index 90% rename from documentation/GUIDE__DEVELOPMENT.md rename to documentation/GUIDE__Development.md index 71bcd943..10726b9d 100644 --- a/documentation/GUIDE__DEVELOPMENT.md +++ b/documentation/GUIDE__Development.md @@ -1,6 +1,6 @@ # Aether Development SOP (Frontend) > **Version:** 1.1 (2026-02-16) -> **Location:** documentation/GUIDE__DEVELOPMENT.md +> **Location:** documentation/GUIDE__Development.md ## 1. 🛡️ Verification (The "Test-First" Mandate) **Rule:** No code is to be committed unless it has passed local verification. Skipping this is a violation of the Aether Dev Protocol. @@ -31,5 +31,8 @@ You are not working in a vacuum. You MUST coordinate with the Backend Agent. Before starting work: 1. Read `~/agents_sync/README.md` to understand the fleet status and cross-agent tasks. 2. Check `README.md` in the project root for technical specs. -3. Review your local `documentation/AGENT_TODO.md` for active tasks. +3. Review your local `documentation/TODO__Agents.md` for active tasks. 4. Be sure to describe the plan before you start making code changes to one or more files. + +## 4. Aether UI/UX and API V3 Documentation +* documentation/GUIDE__AE_API_V3_for_Frontend.md \ No newline at end of file diff --git a/documentation/SVELTE_DEXIE_GUIDE.md b/documentation/GUIDE__SvelteKit2_Svelte5_DexieJS.md similarity index 99% rename from documentation/SVELTE_DEXIE_GUIDE.md rename to documentation/GUIDE__SvelteKit2_Svelte5_DexieJS.md index fceef535..fa339500 100644 --- a/documentation/SVELTE_DEXIE_GUIDE.md +++ b/documentation/GUIDE__SvelteKit2_Svelte5_DexieJS.md @@ -312,3 +312,6 @@ let results = await db.table.where('id').equals(id).reverse().sortBy('sort_key') let results = await db.table.where('id').equals(id).sortBy('sort_key'); return results.reverse(); ``` + +## References +* https://dexie.org/llms.txt - Dexie.js and Dexie Cloud — LLM Guide and Documentation Summary \ No newline at end of file diff --git a/documentation/JOURNALS_CONFIG_MAP.md b/documentation/MODULE__AE Journals_config_map.md similarity index 100% rename from documentation/JOURNALS_CONFIG_MAP.md rename to documentation/MODULE__AE Journals_config_map.md diff --git a/documentation/Aether_Events_Exhibitor_Leads_v3.md b/documentation/PROJECT__AE_Events_Exhibitor_Leads_v3.md similarity index 100% rename from documentation/Aether_Events_Exhibitor_Leads_v3.md rename to documentation/PROJECT__AE_Events_Exhibitor_Leads_v3.md diff --git a/documentation/Aether_Events_Exhibitor_Leads_v3_detail.md b/documentation/PROJECT__AE_Events_Exhibitor_Leads_v3_detail.md similarity index 100% rename from documentation/Aether_Events_Exhibitor_Leads_v3_detail.md rename to documentation/PROJECT__AE_Events_Exhibitor_Leads_v3_detail.md diff --git a/documentation/AE_EVENTS_LAUNCHER_NATIVE_INTEGRATION.md b/documentation/PROJECT__AE_Events_Launcher_Native_integration.md similarity index 100% rename from documentation/AE_EVENTS_LAUNCHER_NATIVE_INTEGRATION.md rename to documentation/PROJECT__AE_Events_Launcher_Native_integration.md diff --git a/documentation/PROJECT_AE_OBJECT_FIELD_EDITOR_V3_UPGRADE.md b/documentation/PROJECT__AE_Object_Field_Editor_V3_upgrade.md similarity index 97% rename from documentation/PROJECT_AE_OBJECT_FIELD_EDITOR_V3_UPGRADE.md rename to documentation/PROJECT__AE_Object_Field_Editor_V3_upgrade.md index 5b766208..53e5088e 100644 --- a/documentation/PROJECT_AE_OBJECT_FIELD_EDITOR_V3_UPGRADE.md +++ b/documentation/PROJECT__AE_Object_Field_Editor_V3_upgrade.md @@ -38,7 +38,7 @@ Consolidate the legacy CRUD components into a single, high-performance "Aether O ### Phase 4: Migration & Cleanup - [x] Create a playground route for V3 verification (`/testing/ae_obj_field_editor_v3`). - [ ] Deprecate and eventually remove `v1` and `v2` files. -- [ ] Update `GUIDE__DEVELOPMENT.md` with the new usage patterns. +- [ ] Update `GUIDE__Development.md` with the new usage patterns. ## ⚠️ Security & Reliability Stabilization (NEW) - [x] **Account Context:** Fixed 403 errors by unifying API helpers to the `/v3/crud/` standard. diff --git a/documentation/PRES_MGMT_SESSION_REFACTOR_PLAN.md b/documentation/PROJECT__AE_Pres_Mgmt_Session_view_refactor_2026-02.md similarity index 100% rename from documentation/PRES_MGMT_SESSION_REFACTOR_PLAN.md rename to documentation/PROJECT__AE_Pres_Mgmt_Session_view_refactor_2026-02.md diff --git a/documentation/AE_UI_Journals_module_update_2026.md b/documentation/PROJECT__AE_UI_Journals_module_update_2026.md similarity index 100% rename from documentation/AE_UI_Journals_module_update_2026.md rename to documentation/PROJECT__AE_UI_Journals_module_update_2026.md diff --git a/documentation/PROJECT_CRUD_V3_UPGRADE.md b/documentation/PROJECT__Use_AE_API_V3_CRUD_upgrade.md similarity index 100% rename from documentation/PROJECT_CRUD_V3_UPGRADE.md rename to documentation/PROJECT__Use_AE_API_V3_CRUD_upgrade.md diff --git a/documentation/AGENT_TODO.md b/documentation/TODO__Agents.md similarity index 100% rename from documentation/AGENT_TODO.md rename to documentation/TODO__Agents.md diff --git a/documentation/Aether_API_CRUD_V3_beta_recommendations.md b/documentation/history/Aether_API_CRUD_V3_beta_recommendations.md similarity index 100% rename from documentation/Aether_API_CRUD_V3_beta_recommendations.md rename to documentation/history/Aether_API_CRUD_V3_beta_recommendations.md diff --git a/documentation/GEMINI_Flowbite_upgrade_2025-12.md b/documentation/history/GEMINI_Flowbite_upgrade_2025-12.md similarity index 100% rename from documentation/GEMINI_Flowbite_upgrade_2025-12.md rename to documentation/history/GEMINI_Flowbite_upgrade_2025-12.md diff --git a/documentation/GEMINI_SkeletonLabs_upgrade_2025-12.md b/documentation/history/GEMINI_SkeletonLabs_upgrade_2025-12.md similarity index 100% rename from documentation/GEMINI_SkeletonLabs_upgrade_2025-12.md rename to documentation/history/GEMINI_SkeletonLabs_upgrade_2025-12.md diff --git a/documentation/GEMINI_debug_notes.md b/documentation/history/GEMINI_debug_notes.md similarity index 100% rename from documentation/GEMINI_debug_notes.md rename to documentation/history/GEMINI_debug_notes.md diff --git a/documentation/old/OLD_README_guidelines_ui_ux.md b/documentation/history/OLD__README__Guidelines_UI_UX.md similarity index 100% rename from documentation/old/OLD_README_guidelines_ui_ux.md rename to documentation/history/OLD__README__Guidelines_UI_UX.md diff --git a/documentation/old/OLD_README_guidelines_v1.md b/documentation/history/OLD__README__Guidelines_v1.md similarity index 100% rename from documentation/old/OLD_README_guidelines_v1.md rename to documentation/history/OLD__README__Guidelines_v1.md diff --git a/documentation/old/OLD_README_guidelines_v2.md b/documentation/history/OLD__README__Guidelines_v2.md similarity index 100% rename from documentation/old/OLD_README_guidelines_v2.md rename to documentation/history/OLD__README__Guidelines_v2.md diff --git a/documentation/AETHER_SVELTE5_PERFORMANCE_REVIEW.md b/documentation/history/REVIEW__AE_Svelte5_performance.md similarity index 100% rename from documentation/AETHER_SVELTE5_PERFORMANCE_REVIEW.md rename to documentation/history/REVIEW__AE_Svelte5_performance.md diff --git a/documentation/V3_API_HARDENING_SESSION_REPORT_2026-01-19.md b/documentation/history/V3_API_HARDENING_SESSION_REPORT_2026-01-19.md similarity index 100% rename from documentation/V3_API_HARDENING_SESSION_REPORT_2026-01-19.md rename to documentation/history/V3_API_HARDENING_SESSION_REPORT_2026-01-19.md diff --git a/documentation/V3_FRONTEND_API_GUIDE.md b/documentation/history/V3_FRONTEND_API_GUIDE.md similarity index 100% rename from documentation/V3_FRONTEND_API_GUIDE.md rename to documentation/history/V3_FRONTEND_API_GUIDE.md