Skip to content

Add architecture documentation explaining convergence algorithm and scoring #34

@that-github-user

Description

@that-github-user

Summary

The convergence algorithm (Jaccard similarity + union-find clustering) and recommendation scoring are non-trivial but only documented in code comments. Contributors and users need to understand:

  1. How convergence works — diff parsing → Jaccard similarity → single-linkage clustering
  2. How scoring works — test pass (100pts) + convergence (0-50pts) + diff size (0-10pts)
  3. Why these choices — why Jaccard over cosine? why 0.3 threshold? why 50/50 weight?
  4. Limitations — what the algorithm misses (semantic equivalence, rename-only changes)

Proposed

Create docs/architecture.md with:

  • System diagram (prompt → parallel agents → convergence → recommendation)
  • Convergence algorithm explanation with examples
  • Scoring formula with rationale
  • Known limitations and future improvements

This is also valuable content for the README and for academic citations.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions