5.6 KiB
5.6 KiB
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.
1) Naming Standard
Use one of these prefixes consistently:
BOOTSTRAP__for first-read onboarding.GUIDE__for cross-module technical guides.MODULE__for module-specific docs.PROJECT__for active, time-bounded workstreams.PROPOSAL__for design proposals not yet adopted.REFERENCE__for evergreen troubleshooting/reference catalogs.
2) Module Coverage Baseline (Active)
Minimum one module doc per active module family:
- Events Presentation Management ->
MODULE__AE_Events_Presentation_Management.md - Events Launcher ->
MODULE__AE_Events_Launcher.md - Events Launcher Native ->
MODULE__AE_Events_Launcher_Native.md - Events Badges ->
MODULE__AE_Events_Badges.md - Events Leads ->
MODULE__AE_Events_Leads.md - Journals ->
MODULE__AE_Journals.md - IDAA Archives ->
MODULE__AE_IDAA_Archives.md - IDAA Bulletin Board ->
MODULE__AE_IDAA_Bulletin_Board.md - IDAA Recovery Meetings ->
MODULE__AE_IDAA_Recovery_Meetings.md - IDAA Video Conferences ->
MODULE__AE_IDAA_Video_Conferences.md
3) Archive Strategy
Archive docs that are superseded, duplicate, or no longer operationally used.
Do not delete historical context; move to documentation/archive/ with clear names.
Completed in this pass
- Moved
MODULE__AE_Events_Launcher_Config_Menu_new.md->archive/PROPOSAL__AE_Events_Launcher_Config_Menu_Unified_Vision_v3_1.md. - Moved
PROPOSAL__IDAA_UI_UX_Roadmap_2026.md->archive/PROPOSAL__IDAA_Recovery_Meetings_UI_UX_Roadmap_2026.md. - Renamed
MODULE__AE Journals_config_map.md->MODULE__AE_Journals_Config_Map.md. - Renamed
PROJECT__AE_UI_Journals_module_update_2026.md->PROJECT__AE_UI_Journals_Module_Update_2026.md. - 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 isGUIDE__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/*.mdreferences 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.
- Archived legacy API-object, component-inventory, data-structure, performance, and UI-pattern references that contradicted V3 IDs, Svelte 5, or current private-route execution rules.
- Refreshed
AE__Architecture.mdandAE__Naming_Conventions.mdas the active replacements. - Added
documentation/archive/README.mdto explain archive categories and restoration policy. - Renamed
AE__Docker_CI_Cache_Policy.md->GUIDE__Docker_CI_Cache_Policy.md. - Renamed
AE__UI_UX_future_ideas.md->PROPOSAL__AE_UI_UX_Future_Ideas.md. - Audited the Journals UI update against current source and archived
PROJECT__AE_UI_Journals_Module_Update_2026.md; remaining security work was moved to the active task list and module documentation. - Audited the Badges review/print project against current source and archived
PROJECT__AE_Events_Badges_Review_Print.md; email delivery and permission-source unification remain active follow-ups. - Audited Site Passcode Security against current source. It remains an active high-priority project because plaintext client storage and local passcode comparison are still present.
- Audited V3 CRUD upgrade project against source (2026-06-12). All production code migrated
to V3; legacy wrappers remain exported but unused. Archived
PROJECT__Use_AE_API_V3_CRUD_upgrade.md. Optional cleanup task added to TODO for removing dead wrapper code. - Audited Field Editor V3 project against source (2026-06-12). Component complete with 50+ active
usages, GUIDE documentation, and all core field types. Searchable dropdowns deferred as optional
enhancement. Archived
PROJECT__AE_Object_Field_Editor_V3_upgrade.md. - Audited Pres Mgmt Config Cleanup project (2026-06-12). Core infrastructure working (~70% complete)
but regressions identified:
show__launcher_link_legacymissing from schema, old settings form not removed, local/remote key conflicts. Updated project doc with regression fixes; keeping active.
Next archive candidates (review + approve)
- Older style-review snapshots once current style guide references are centralized.
- Closed project docs where TODO/archive already capture final status.
- Duplicate docs where one
MODULE__file and onePROJECT__file now overlap heavily.
4) Review Cadence
Monthly lightweight review:
- Verify
BOOTSTRAP__AI_Agent_Quickstart.mdlinks still resolve and reflect active work. - Verify each active module has one current
MODULE__anchor doc. - Move stale proposals and completed projects into archive.
- Update
REFERENCE__Common_Agent_Mistakes.mdkeep/archive sections.
5) Immediate Follow-Up Tasks
- Continue quarterly archive reviews for remaining stale
PROJECT__docs; the Journals and Badges projects were archived on 2026-06-12, while Site Passcode Security remains active. - Continue the broader permission-helper and IDAA authentication review; the Site Passcode section was source-verified on 2026-06-12.
- Review module docs against current routes and store names rather than relying only on filename/header freshness.
- Add a lightweight reusable link-check script if manual path validation becomes frequent.