docs: fifth-pass guide metadata and doc ownership cues

This commit is contained in:
Scott Idem
2026-06-12 16:58:23 -04:00
parent e966261324
commit 1e3f541a39
11 changed files with 23 additions and 4 deletions

View File

@@ -1,4 +1,5 @@
# Aether SvelteKit — AI Agent Bootstrap / Quickstart # Aether SvelteKit — AI Agent Bootstrap / Quickstart
> **Doc Owner:** Frontend platform maintainers (OSIT) + active coding agents
> **Read this first.** This doc is the fast path to being productive on this project. > **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. > It covers the rules, patterns, and gotchas that matter most.
> Deep dives are in the linked docs at the bottom. > Deep dives are in the linked docs at the bottom.

View File

@@ -1,5 +1,7 @@
# Aether API V3 Frontend Integration Guide (Svelte/TypeScript) # Aether API V3 Frontend Integration Guide (Svelte/TypeScript)
**Last Updated:** 2026-06-12
This guide defines the standards for interacting with the **Aether API V3 CRUD** and **Action** endpoints. This guide defines the standards for interacting with the **Aether API V3 CRUD** and **Action** endpoints.
--- ---

View File

@@ -1,5 +1,7 @@
# Aether API V3 WebSocket Integration Guide # Aether API V3 WebSocket Integration Guide
**Last Updated:** 2026-06-12
This guide explains how to implement real-time communication using the **Aether API V3 WebSocket** protocol. V3 introduces granular routing, strict message schemas, and improved multi-tenant isolation compared to previous versions. This guide explains how to implement real-time communication using the **Aether API V3 WebSocket** protocol. V3 introduces granular routing, strict message schemas, and improved multi-tenant isolation compared to previous versions.
--- ---

View File

@@ -1,5 +1,7 @@
# Aether Events — Onsite Badge Printing # Aether Events — Onsite Badge Printing
**Last Updated:** 2026-06-12
Notes on setup, process, hardware, and browser behavior for onsite badge printing at events. Notes on setup, process, hardware, and browser behavior for onsite badge printing at events.
For cross-module onsite operations (SRR, launcher monitoring, exhibitor leads support), see: For cross-module onsite operations (SRR, launcher monitoring, exhibitor leads support), see:

View File

@@ -1,5 +1,7 @@
# Guide — Aether Events: Onsite Runbook # Guide — Aether Events: Onsite Runbook
**Last Updated:** 2026-06-12
This guide covers the human-centric logistics and "In the Heat of the Moment" support for onsite event operations. This guide covers the human-centric logistics and "In the Heat of the Moment" support for onsite event operations.
--- ---

View File

@@ -1,5 +1,7 @@
# Stability Patterns for liveQuery + Svelte 5 # Stability Patterns for liveQuery + Svelte 5
**Last Updated:** 2026-06-12
Dexie's `liveQuery` works well with Svelte 5 runes, but the combination requires a few stable patterns so queries don't get recreated unintentionally and components render correctly on a "cold start" (empty IndexedDB). Dexie's `liveQuery` works well with Svelte 5 runes, but the combination requires a few stable patterns so queries don't get recreated unintentionally and components render correctly on a "cold start" (empty IndexedDB).
- Keep the observable instance stable: wrap `liveQuery` in a stable `$derived` so the observable isn't recreated on every render. Recreate the `liveQuery` only when explicit dependencies change (IDs, filters, or search keys). - Keep the observable instance stable: wrap `liveQuery` in a stable `$derived` so the observable isn't recreated on every render. Recreate the `liveQuery` only when explicit dependencies change (IDs, filters, or search keys).

View File

@@ -3,6 +3,7 @@
**Status:** Planning / Ready to Execute **Status:** Planning / Ready to Execute
**Priority:** High (BGH conference in ~2 weeks; only one active event using pres_mgmt) **Priority:** High (BGH conference in ~2 weeks; only one active event using pres_mgmt)
**Created:** 2026-04-02 **Created:** 2026-04-02
**Last Updated:** 2026-06-12
**Related:** `TODO__Agents.md`, `PROJECT__Stores_Svelte5_Migration.md` **Related:** `TODO__Agents.md`, `PROJECT__Stores_Svelte5_Migration.md`
--- ---

View File

@@ -1,5 +1,7 @@
# Project: Documentation Refresh and Archive Plan (2026) # Project: Documentation Refresh and Archive Plan (2026)
**Last Updated:** 2026-06-12
**Goal:** Keep onboarding docs fast and current while preserving historical context in archive. **Goal:** Keep onboarding docs fast and current while preserving historical context in archive.
## 1) Naming Standard ## 1) Naming Standard
@@ -55,7 +57,7 @@ Monthly lightweight review:
## 5) Immediate Follow-Up Tasks ## 5) Immediate Follow-Up Tasks
1. Run a link-check pass across documentation files. 1. Add `Last Updated` metadata lines to remaining active docs that still only encode dates via `Version` or legacy `Last updated` casing.
2. Add `Last Updated` metadata lines to remaining `GUIDE__` and `PROJECT__` docs that are still actively edited. 2. Promote one consistent `Last Updated` format (`**Last Updated:** YYYY-MM-DD`) across all active docs.
3. Run a lightweight cross-reference audit for `archive/` links in active docs to ensure all moved files remain discoverable. 3. Run a quarterly archive review: identify stale `PROJECT__` docs with no TODO linkage and move to `documentation/archive/`.
4. Add a short "Doc Owner" line for high-churn docs (`BOOTSTRAP__*`, `TODO__Agents.md`, and `README__Docs_Index.md`) so update responsibility stays explicit. 4. Add a short "Review Trigger" line to high-churn docs (for example, "update after any commit that renames docs or changes module routes").

View File

@@ -1,5 +1,7 @@
# PROJECT: IDAA `idaa_loc` Migration to Svelte 5 `PersistedState` # PROJECT: IDAA `idaa_loc` Migration to Svelte 5 `PersistedState`
**Last Updated:** 2026-06-12
## Objective ## Objective
Migrate IDAA persisted local state from legacy `svelte-persisted-store` (`$idaa_loc`) to Svelte 5 `PersistedState` (`idaa_loc.current`) without behavior regressions, auth leaks, or broken page flows. Migrate IDAA persisted local state from legacy `svelte-persisted-store` (`$idaa_loc`) to Svelte 5 `PersistedState` (`idaa_loc.current`) without behavior regressions, auth leaks, or broken page flows.

View File

@@ -1,5 +1,7 @@
# Aether SvelteKit — Documentation Index # Aether SvelteKit — Documentation Index
**Doc Owner:** Frontend platform maintainers (OSIT)
Use this file as the routing map for project documentation. Use this file as the routing map for project documentation.
## 1) First Read ## 1) First Read

View File

@@ -1,4 +1,5 @@
# Frontend Agent Task List # Frontend Agent Task List
> **Doc Owner:** Active frontend implementation team (human + agent)
> Use this file to track steps for complex features or bug fixes. > Use this file to track steps for complex features or bug fixes.
> **Status:** Stable — ongoing development. > **Status:** Stable — ongoing development.
> **Scope:** Active/open work only. Completed detail lives in archive files. > **Scope:** Active/open work only. Completed detail lives in archive files.