Skip to content

Initialize main: documentation & architecture foundation#21

Merged
sid-ak merged 10 commits into
mainfrom
dev
Jun 24, 2026
Merged

Initialize main: documentation & architecture foundation#21
sid-ak merged 10 commits into
mainfrom
dev

Conversation

@sid-ak

@sid-ak sid-ak commented Jun 24, 2026

Copy link
Copy Markdown
Owner

Summary

Inaugural merge of dev into main, establishing the project's documentation and decision-record foundation. This is an init-style PR: it brings the entire current dev history onto main as the baseline for all future work. No application code yet — the focus is a clear, agreed structure before implementation begins.

Motivation & context

main starts empty; all groundwork so far lives on dev. This PR promotes that groundwork to the mainline so subsequent feature work has a stable base and a documented architecture to build against. The build plan itself has been extracted from a flat plan.md into tracked GitHub issues (phases + improvement sub-issues), so planning now lives in the tracker rather than in-repo prose.

Changes

Architecture

  • docs/architecture.md — restructured around goals, conciseness, and readability; notes the intentional Claude coupling.
  • docs/assets/architecture.svg — architecture diagram (migrated from PNG to SVG).

Decision records (ADRs) in docs/decisions/

  • 0000-stack.md — justifies the overall stack choices.
  • 0001-rag-retrieval-boundary.md — RAG retrieval boundary.
  • 0002-local-embedding-and-reranking.md — local embedding + reranking.
  • 0003-local-single-user-scope.md — local, single-user scope.
  • 0004-cli-batch-ingestion.md — CLI batch ingestion.
  • README.md — ADR index/conventions.

Project tooling

  • .gitignore — Python/tooling ignores, plus Claude and local issue-tracker artifacts.
  • .github/PULL_REQUEST_TEMPLATE.md — best-practice PR template (introduced in this PR).
  • plan.md removed — superseded by GitHub issues.

Type of change

  • Improvement

Related issues

Build plan and improvements are tracked as issues 1–19 (phase issues with improvement sub-issues). No issue is closed by this PR — it lays the documentation baseline those phases build on.

Verification

  • Markdown renders on GitHub; the architecture SVG displays inline.
  • ADRs 0000–0004 present and linked from docs/decisions/README.md.
  • Diff reviewed: docs/ADRs only, no stray or accidental files.

Decision records

  • ADR 0000 — Stack (Accepted)
  • ADR 0001 — RAG retrieval boundary (Accepted)
  • ADR 0002 — Local embedding & reranking (Accepted)
  • ADR 0003 — Local single-user scope (Accepted)
  • ADR 0004 — CLI batch ingestion (Accepted)

🤖 Generated with Claude Code

@sid-ak sid-ak self-assigned this Jun 24, 2026
@sid-ak sid-ak merged commit 0b7548b into main Jun 24, 2026
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.

1 participant