Skip to content

docs: architecture guide, docs map, CLI readme, agent-doc sync - #17

Merged
kuladeepmantri merged 1 commit into
mainfrom
docs/architecture-and-docs-map
Jul 20, 2026
Merged

kuladeepmantri merged 1 commit into
mainfrom
docs/architecture-and-docs-map

Conversation

@kuladeepmantri

Copy link
Copy Markdown
Collaborator

Summary

Grows docs/ into a real entry point and syncs the agent docs with shipped reality.

What changed

  • docs/README.md: a documentation map (users, contributors, designers)
  • docs/ARCHITECTURE.md: public architecture guide - crate map, dependency direction, run flow, the rules that shape changes, extension points, testing conventions
  • crates/evalcore/README.md: the missing CLI crate readme for crates.io
  • CLAUDE.md + AGENTS.md: workspace table now lists evalcore-serve and the current scorer/reporter sets; note pointing agents at the local private knowledge base
  • .gitignore: guard the local wiki/ and PRD export so internal material cannot enter this history

Why

Post-launch traffic lands on the repo; contributors need an architecture entry point that does not require reading seven crate docs. The agent docs had drifted from what actually shipped in 0.7.x.

How to test

Docs-only change. Check links resolve on the GitHub file views; git check-ignore wiki/ prd.zip both match.

Risks / follow-ups

None; no code paths touched.

🤖 Generated with Claude Code

https://claude.ai/code/session_013WcW3UberW5gdML6w5nBzi

Grow docs/ into a real entry point: a documentation map and a public
architecture guide (crate map, run flow, the rules that shape changes,
extension points). Add the missing crates/evalcore README for crates.io.
Sync CLAUDE.md and AGENTS.md with shipped reality (evalcore-serve crate,
current scorer and reporter sets) and note the gitignored private wiki
so agents know where product context lives. Guard wiki/ and the PRD
export in .gitignore so internal material cannot enter this history.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013WcW3UberW5gdML6w5nBzi
@kuladeepmantri
kuladeepmantri merged commit 436a3a2 into main Jul 20, 2026
2 checks passed
@kuladeepmantri
kuladeepmantri deleted the docs/architecture-and-docs-map branch July 20, 2026 18:16
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