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 Naming Conventions
**Last Updated:** 2026-06-12
## 1. General Principles
- **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`)
- **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:**
- **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`)
- **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`)
@@ -37,9 +40,9 @@
- **Singularity:** Use singular nouns for objects and properties (e.g., `example.id`, not `examples.id`).
- **IDs:**
- `id`: Primary key for an object (internal use, often a UUID).
- `<object_type>_id`: Specific ID for an object (e.g., `person_id`).
- `<object_type>_id_random`: Randomly generated ID for an object (often used for external exposure or URL parameters).
- `<object_type>_id`: Canonical randomized string ID returned by V3 (for example, `person_id`).
- `id`: Generic randomized string alias when V3 returns one; never assume it is an integer autonumber.
- `<object_type>_id_random`: Legacy alias; do not introduce new usage.
- `account_id`, `site_id`, `user_id`, etc.: Foreign keys.
- **Common Properties:**
- `code`: Short, unique identifier.
@@ -88,6 +91,6 @@
- `<module>` (extended modules)
- `<custom>` (custom modules)
- **IndexedDB:**
- `ae_core_db`
- `<module>`
- `db_core`
- `db_<module>` (for example, `db_events`, `db_journals`)
- `<custom>`