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 <noreply@anthropic.com>
This commit is contained in:
132
README.md
132
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:
|
||||
|
||||
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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.
|
||||
Reference in New Issue
Block a user