Skip to content

docs: add design specification and initial ADRs - #1

Merged
lucaosti merged 3 commits into
mainfrom
docs/design-spec
Oct 22, 2026
Merged

lucaosti merged 3 commits into
mainfrom
docs/design-spec

Conversation

@lucaosti

Copy link
Copy Markdown
Collaborator

What

  • docs/specs/2026-10-16-agentic-rag-design.md is the design specification for the repository. It covers:
    • context and findings from the BitPolito Academy codebase;
    • goals and non-goals;
    • the repository layout (uv workspace);
    • the engine architecture (ports and adapters);
    • the Code-RAG architecture;
    • the evaluation and benchmark methodology;
    • milestones with exit criteria;
    • engineering conventions;
    • risks.
  • docs/adr/0001 to 0004 record the foundational decisions:
    • ports and adapters;
    • a uv workspace monorepo;
    • QVAC as an optional adapter;
    • copy-then-migrate from Academy.

Why

These documents fix the contracts and the plan before any code lands, so that the Engine and Research tracks can proceed in parallel against shared interfaces. The milestones and issues will be derived from section 8 of the spec.

How to review

  • Read the spec end to end. Focus on section 5 (ports and rules), section 8 (milestones and exit criteria) and section 9 (conventions).
  • Each ADR is in Proposed status. Merging this PR accepts them. A follow-up will flip their status to Accepted.

Verification

Documentation only. No code and no CI yet. CI arrives with milestone M0.

There is no tracking issue yet. Issues will be created from this spec once it is merged.

Record the agreed design for the Agentic-RAG repository:

- the domain-agnostic engine extracted from BitPolito Academy;
- the AST-aware Code-RAG research track;
- milestones with exit criteria;
- engineering conventions.

ADR-0001 to ADR-0004 capture these foundational decisions:

- ports and adapters;
- a uv workspace monorepo;
- QVAC as an optional adapter;
- copy-then-migrate from Academy.
The backlog follows a rolling-wave model.

- M0, M1, M2, E1 and R1 are broken down into ready-to-pick issues with acceptance criteria and verification commands.
- E2 to E6 and R2 to R5 are tracked as epics. Their sub-issues are detailed when the preceding milestone closes.
@lucaosti

Copy link
Copy Markdown
Collaborator Author

Merged without an approving review by maintainer decision, to unblock contributors: this is the foundation chain everything else depends on. Verified locally on the combined chain (#1, #45, #46, #47, #49, #50 merged together, no conflicts): uv sync --locked, ruff check and format, mypy, import-linter (3 contracts kept), pytest with 100% coverage.

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