Skip to content

docs: consolidate branches into main — fix architecture drift, complete sprint docs, add Quick Start#17

Merged
aj1126 merged 1 commit into
mainfrom
copilot/merge-branches-into-main
Jun 26, 2026
Merged

docs: consolidate branches into main — fix architecture drift, complete sprint docs, add Quick Start#17
aj1126 merged 1 commit into
mainfrom
copilot/merge-branches-into-main

Conversation

Copilot AI commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Full branch inventory (15 branches): main already contains all roadmap stages 1–5. All branches ahead of main hold older intermediate states that main supersedes; no feature code was missing.
  • docs/architecture.md: Removed stale "Not yet implemented" block (PDF/OCR ingestion, NER, and dashboard are all implemented). Rewrote Current Runtime Boundaries to accurately reflect the live stack: multithreaded worker pool, PDF/OCR (.pdf/.png/.jpg/.jpeg), NLP via compromise (#Date/#Place), TF-IDF + Cosine Similarity, watch mode, GUI, telemetry, and all CLI flags.
  • docs/SPRINT_01/02/03.md: Marked all task and Definition of Done checkboxes [x]. Fixed embedded control characters and truncated npm command strings (pm runnpm run, etc.) left by the original authoring tool.
  • README.md: Added Quick Start section (four-command setup block) after the Table of Contents, with a matching ToC entry. Concept adapted from the feature/readme-quick-start branch, which was too far behind main to merge directly.

Checklist

  • I reviewed whether this change affects README, architecture docs, or legacy docs.
  • If commands, supported file types, or layout metadata changed, I ran npm run docs:generate.
  • I ran npm run docs:check.
  • If historical Python prototype guidance changed, I updated docs/legacy-prototype.md.

- Update docs/architecture.md: expand Current Runtime Boundaries to
  reflect all implemented features (PDF/OCR ingestion, NLP via
  compromise, GUI, watch mode, TF-IDF, telemetry); remove the stale
  'not yet implemented' block.
- Mark all tasks and Definition of Done items complete in
  docs/SPRINT_01.md, SPRINT_02.md, and SPRINT_03.md; fix control
  characters and truncated command names introduced by the original
  authoring tool.
- Add Quick Start section to README with four-command setup block;
  add entry to the Table of Contents.
- All 21 tests pass; npm run docs:check passes.
Copilot AI requested a review from aj1126 June 26, 2026 07:10
@aj1126 aj1126 marked this pull request as ready for review June 26, 2026 07:16
@aj1126 aj1126 merged commit b47ac2c into main Jun 26, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants