Skip to content

docs: rewrite README with verified eval results and architecture flow - #5

Merged
MomoSolaris8 merged 1 commit into
mainfrom
docs/readme-verified-results
Aug 8, 2026
Merged

docs: rewrite README with verified eval results and architecture flow#5
MomoSolaris8 merged 1 commit into
mainfrom
docs/readme-verified-results

Conversation

@MomoSolaris8

Copy link
Copy Markdown
Owner

docs: lead README with verified evaluation results

Restructure the README so the first screen shows measured evidence
instead of prose.

  • Add a results-first opening: one-line positioning, design-decision
    table with file references, and the real claim-review eval output
    (12/12 cases, 4 gated metrics, dataset fingerprint)
  • Replace the mermaid architecture graph with a plain-text request
    path from api/ask.py through the LangGraph nodes to AskResponse
  • Document the three external gateways (LLM registry, MCP tools,
    Postgres/pgvector) and why the graph is deliberately static
  • Fix the online benchmark command: it is
    supportagent.evaluation.online_runner, not a --suite flag
  • Translate the end-to-end test section to English and demote its
    stray H1 heading to H3

@vercel

vercel Bot commented Aug 8, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
support-agent-one-coyl Ready Ready Preview Aug 8, 2026 2:52pm

@MomoSolaris8
MomoSolaris8 merged commit cfa9309 into main Aug 8, 2026
3 of 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.

1 participant