bytelyst/learning_ai_notes
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(cleanup): move historical roadmaps to docs/archive/ and update AGENTS.md

Browse Source 
Sprint B — closes audit item B7 (doc consolidation).

- docs/AGENT_TASK_ROADMAP.md, docs/ARCHITECTURE_REVIEW_AND_REUSE_ROADMAP.md,
  docs/GAP_ANALYSIS.md were each self-marked as historical snapshots
  but kept polluting the top of docs/. Moved them under docs/archive/
  in the previous commit; this commit:
  - Adds docs/archive/README.md explaining what's archived vs active
  - Repoints cross-doc links in docs/IMPLEMENTATION_TRACKER.md,
    docs/WEB_AI_FAST_ROADMAP.md, and docs/roadmaps/*.md to the new
    archive paths
  - Fixes relative links inside the archived files themselves so
    historical readers can still navigate back to active docs
- AGENTS.md §1.1 refreshed: reflects the May 22 re-verified state
  (382/96/97 tests), links the two new runbooks, and points readers
  away from docs/archive/ as a work source.
This commit is contained in:
saravanakumardb1 2026-05-22 23:23:50 -07:00
parent bcad7d330a
commit 4667f85e20
11 changed files with 31 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
AGENTS.md
View File

@ -20,10 +20,11 @@
## 1.1 Production-Readiness Status
As of May 5, 2026, the active handoff is complete with explicit environment deferrals recorded in `docs/PRODUCTION_READINESS_HANDOFF_ROADMAP.md`.
As of May 22, 2026 (Sprint A + Sprint B re-verification), `pnpm run verify` is green end-to-end. See `docs/PRODUCTION_READINESS_HANDOFF_ROADMAP.md` § Post-Sprint-A Re-verification and `docs/NEXT_SPRINT_ROADMAP.md` for current sprint plan.
- Passing local gates: `pnpm run verify`, backend/web/mobile lint, web Playwright release flows, release-guard audit, product/API drift audit, and `git diff --check`.
- Expected non-failing warnings: backend/web/mobile lint advisories, mobile `react-test-renderer` deprecation, and Next `--localstorage-file`.
- Passing local gates: `pnpm run verify` (backend 382/382, web 96/96, mobile 97/97), backend/web/mobile lint (warnings only), `pnpm run audit:release-guards`, `git diff --check`.
- Operational runbooks: `docs/runbooks/MEK_ROTATION.md`, `docs/runbooks/SECRET_MANAGEMENT.md`.
- Archived (no longer active) execution docs live under `docs/archive/` — keep them for context but do not use them as work sources.
- Environment deferrals: Docker compose smoke needs a Docker-capable host; shared-service smoke needs platform-service, extraction-service, mcp-server, and Cosmos credentials.
## 2. Repo Layout

4
docs/IMPLEMENTATION_TRACKER.md
View File

@ -1,7 +1,7 @@
# NoteLett — Implementation Tracker
**Created:** March 19, 2026
**Source:** `docs/GAP_ANALYSIS.md` (25 gaps across 5 categories)
**Source:** `docs/archive/GAP_ANALYSIS.md` (25 gaps across 5 categories)
**Companion docs:** `docs/PRD.md`, `docs/ROADMAP.md`, `AGENTS.md`
---
@ -421,7 +421,7 @@ feat(web): summarize + export UI triggers [B3, B6]
- Add any new API endpoints added in Phases 2–7
- Update repo layout if new files/dirs were added
- [x] **8.3** Update `docs/GAP_ANALYSIS.md` final status
- [x] **8.3** Update `docs/archive/GAP_ANALYSIS.md` final status
- Add completion notes to each resolved gap
- Update the totals table with final numbers

2
docs/archive/AGENT_TASK_ROADMAP.md
View File

@ -1,6 +1,6 @@
# NoteLett — Agent Task Roadmap
> **Historical snapshot.** This March 31, 2026 task roadmap is superseded for production-readiness execution. In particular, the old claim that common-platform backend package sources are missing is stale: those packages now exist under `../learning_ai/learning_ai_common_plat/packages/`. Use [`docs/PRODUCTION_READINESS_HANDOFF_ROADMAP.md`](PRODUCTION_READINESS_HANDOFF_ROADMAP.md) as the active checklist.
> **Historical snapshot.** This March 31, 2026 task roadmap is superseded for production-readiness execution. In particular, the old claim that common-platform backend package sources are missing is stale: those packages now exist under `../learning_ai/learning_ai_common_plat/packages/`. Use [`docs/PRODUCTION_READINESS_HANDOFF_ROADMAP.md`](../PRODUCTION_READINESS_HANDOFF_ROADMAP.md) as the active checklist.
**Date:** March 31, 2026
**Product:** NoteLett (`notelett`) — Structured notes for humans + AI agents

2
docs/archive/ARCHITECTURE_REVIEW_AND_REUSE_ROADMAP.md
View File

@ -1,6 +1,6 @@
# NoteLett — Architecture Review, Gap Analysis, and Reuse-First Action Plan
> **Historical architecture review.** This March 10, 2026 review remains useful context for product-local versus common-platform boundaries, but it is not the active implementation tracker. Use [`docs/PRODUCTION_READINESS_HANDOFF_ROADMAP.md`](PRODUCTION_READINESS_HANDOFF_ROADMAP.md) for current production-readiness work and commit tracking.
> **Historical architecture review.** This March 10, 2026 review remains useful context for product-local versus common-platform boundaries, but it is not the active implementation tracker. Use [`docs/PRODUCTION_READINESS_HANDOFF_ROADMAP.md`](../PRODUCTION_READINESS_HANDOFF_ROADMAP.md) for current production-readiness work and commit tracking.
Version: 1.0
Date: March 10, 2026

2
docs/archive/GAP_ANALYSIS.md
View File

@ -1,6 +1,6 @@
# NoteLett — Gap Analysis
> **Historical snapshot.** This March 19, 2026 audit is no longer an active execution source. Several gaps listed here have since been implemented, and several pass/fail counts are stale. Use [`docs/PRODUCTION_READINESS_HANDOFF_ROADMAP.md`](PRODUCTION_READINESS_HANDOFF_ROADMAP.md) as the active production-readiness checklist and [`docs/ROADMAP.md`](ROADMAP.md) for reconciled current status.
> **Historical snapshot.** This March 19, 2026 audit is no longer an active execution source. Several gaps listed here have since been implemented, and several pass/fail counts are stale. Use [`docs/PRODUCTION_READINESS_HANDOFF_ROADMAP.md`](../PRODUCTION_READINESS_HANDOFF_ROADMAP.md) as the active production-readiness checklist and [`docs/ROADMAP.md`](../ROADMAP.md) for reconciled current status.
**Date:** March 19, 2026
**Auditor:** Cascade (systematic code review)

17
docs/archive/README.md Normal file
View File

@ -0,0 +1,17 @@
# Archived Docs
These documents are kept for historical context but are **not** active execution sources. Each was explicitly marked as a historical snapshot or superseded by a later roadmap.
| File | Original date | Why archived |
|---|---|---|
| [`AGENT_TASK_ROADMAP.md`](./AGENT_TASK_ROADMAP.md) | March 31, 2026 | Superseded by `PRODUCTION_READINESS_HANDOFF_ROADMAP.md`. Pre-dated several common-platform package additions. |
| [`ARCHITECTURE_REVIEW_AND_REUSE_ROADMAP.md`](./ARCHITECTURE_REVIEW_AND_REUSE_ROADMAP.md) | March 10, 2026 | Useful context on product-local vs. common-platform boundaries, but no longer the active tracker. |
| [`GAP_ANALYSIS.md`](./GAP_ANALYSIS.md) | March 19, 2026 | Several gaps in this audit have since been implemented; pass/fail counts are stale. |
## Active docs (do not archive)
- [`../ROADMAP.md`](../ROADMAP.md) — primary phase roadmap.
- [`../NEXT_SPRINT_ROADMAP.md`](../NEXT_SPRINT_ROADMAP.md) — current sprint focus.
- [`../PRODUCTION_READINESS_HANDOFF_ROADMAP.md`](../PRODUCTION_READINESS_HANDOFF_ROADMAP.md) — production gate checklist.
- [`../UI_UX_PLATFORM_CORE_ROADMAP.md`](../UI_UX_PLATFORM_CORE_ROADMAP.md) — UI migration roadmap.
- [`../runbooks/`](../runbooks/) — operational runbooks (MEK rotation, secret management, ...).

2
docs/roadmaps/08_ARCHITECTURE_REUSE_MASTER_ROADMAP.md
View File

@ -3,7 +3,7 @@
> **Historical reuse roadmap.** This draft is superseded by [`../PRODUCTION_READINESS_HANDOFF_ROADMAP.md`](../PRODUCTION_READINESS_HANDOFF_ROADMAP.md) for active production-readiness execution. Keep it as context only unless the active roadmap explicitly reopens an item.
Status: Draft
Parent: `docs/ARCHITECTURE_REVIEW_AND_REUSE_ROADMAP.md`
Parent: `docs/archive/ARCHITECTURE_REVIEW_AND_REUSE_ROADMAP.md`
Scope: Whole repo architecture alignment
# Purpose

2
docs/roadmaps/09_BACKEND_REUSE_ALIGNMENT_ROADMAP.md
View File

@ -3,7 +3,7 @@
> **Historical reuse roadmap.** This draft is superseded by [`../PRODUCTION_READINESS_HANDOFF_ROADMAP.md`](../PRODUCTION_READINESS_HANDOFF_ROADMAP.md) for active production-readiness execution. Backend platform/API drift is currently tracked there in P0.5, P2, P3, and P5.
Status: Draft
Parent: `docs/ARCHITECTURE_REVIEW_AND_REUSE_ROADMAP.md`
Parent: `docs/archive/ARCHITECTURE_REVIEW_AND_REUSE_ROADMAP.md`
Scope: `backend/`
# Goal

2
docs/roadmaps/10_WEB_REUSE_ALIGNMENT_ROADMAP.md
View File

@ -3,7 +3,7 @@
> **Historical reuse roadmap.** This draft is superseded by [`../PRODUCTION_READINESS_HANDOFF_ROADMAP.md`](../PRODUCTION_READINESS_HANDOFF_ROADMAP.md) for active production-readiness execution. Current web design-system, accessibility, auth, E2E, and production UX work is tracked there.
Status: Draft
Parent: `docs/ARCHITECTURE_REVIEW_AND_REUSE_ROADMAP.md`
Parent: `docs/archive/ARCHITECTURE_REVIEW_AND_REUSE_ROADMAP.md`
Scope: `web/`
# Goal

2
docs/roadmaps/11_MOBILE_REUSE_ALIGNMENT_ROADMAP.md
View File

@ -3,7 +3,7 @@
> **Historical reuse roadmap.** This draft is superseded by [`../PRODUCTION_READINESS_HANDOFF_ROADMAP.md`](../PRODUCTION_READINESS_HANDOFF_ROADMAP.md) for active production-readiness execution. Current mobile SDK/sync/platform decisions are tracked there in P2 and P7.
Status: Draft
Parent: `docs/ARCHITECTURE_REVIEW_AND_REUSE_ROADMAP.md`
Parent: `docs/archive/ARCHITECTURE_REVIEW_AND_REUSE_ROADMAP.md`
Scope: `mobile/`
# Goal

2
docs/roadmaps/12_PLATFORM_SHARED_SERVICES_ALIGNMENT_ROADMAP.md
View File

@ -3,7 +3,7 @@
> **Historical reuse roadmap.** This draft is superseded by [`../PRODUCTION_READINESS_HANDOFF_ROADMAP.md`](../PRODUCTION_READINESS_HANDOFF_ROADMAP.md) for active production-readiness execution. Current platform-service, extraction-service, MCP, telemetry, diagnostics, flags, kill switch, and blob smoke work is tracked there in P2 and P8.
Status: Draft
Parent: `docs/ARCHITECTURE_REVIEW_AND_REUSE_ROADMAP.md`
Parent: `docs/archive/ARCHITECTURE_REVIEW_AND_REUSE_ROADMAP.md`
Scope: cross-cutting shared service/package adoption
# Goal