docs: restructure bootstrap, add module references, and normalize docs

This commit is contained in:
Scott Idem
2026-06-12 16:48:35 -04:00
parent e05602b87b
commit a227c6aaa7
11 changed files with 511 additions and 237 deletions

View File

@@ -0,0 +1,55 @@
# Project: Documentation Refresh and Archive Plan (2026)
**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`.
### 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 one `PROJECT__` file now overlap heavily.
## 4) Review Cadence
Monthly lightweight review:
1. Verify `BOOTSTRAP__AI_Agent_Quickstart.md` links still resolve and reflect active work.
2. Verify each active module has one current `MODULE__` anchor doc.
3. Move stale proposals and completed projects into archive.
4. Update `REFERENCE__Common_Agent_Mistakes.md` keep/archive sections.
## 5) Immediate Follow-Up Tasks
1. Add a single docs index (`documentation/README__Docs_Index.md`) with routing by task type.
2. Normalize any remaining filenames with spaces or inconsistent separators.
3. Add `Last Updated` metadata lines to all `MODULE__` docs.
4. Run a link-check pass across documentation files.