Skip to content

docs: simplify README and harness docs #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eunaverse merged 3 commits into from
Jun 15, 2026
Merged

docs: simplify README and harness docs #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bb60a02
docs: simplify README and harness docs
eunaverse Jun 15, 2026
db83834
merge: preserve docs conflict resolution for pr 73
eunaverse Jun 15, 2026
0d4b208
docs: fold core understanding into architecture
eunaverse Jun 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 21 additions & 6 deletions .agents/docs/adr/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,22 @@
# Architecture Decision Records

This directory records architecture decisions for `MCPContentSearch`.
This directory records historical architecture decisions for
`MCPContentSearch`.

Harness planning reads this index first, then opens only accepted ADRs directly related to the requested change. Review gates treat accepted ADRs as contracts. If a diff conflicts with an accepted ADR, either change the diff or add a new ADR that supersedes the old decision.
For current work, the maintained source of truth is
`.agents/docs/architecture.md`. Harness planning and review do not require
reading ADRs. Keep this directory as optional historical context for older plan
docs, superseded decisions, or cases where a reader explicitly wants the
original decision record.

If an ADR and `.agents/docs/architecture.md` disagree, follow the architecture
doc and update the historical ADR wording only when that extra archival cleanup
is worth doing.

## ADR Format

Use `template.md` for new records.
Use `template.md` only when you explicitly want to preserve a standalone
decision record in this archive.

Required fields:

Expand Down Expand Up @@ -35,14 +45,19 @@ File names should be numbered and descriptive:

## When to Add or Update ADRs

Add or update an ADR for:
Add or update an ADR only when preserving the separate historical decision
record is itself useful.

Typical cases:

- New cross-module architecture patterns.
- MCP tool contract strategy changes.
- Search/indexing persistence strategy changes.
- Chroma data migration or reindexing policy.
- External integration strategy changes.
- Configuration/secrets policy changes.
- Intentional departures from `.agents/docs/architecture.md`.
- Architecture changes worth preserving historically after updating
`.agents/docs/architecture.md`.

Do not add ADRs for ordinary local refactors, one-off bug fixes, or implementation details that do not constrain future work.
Do not add ADRs for ordinary local refactors, one-off bug fixes, or
implementation details that do not constrain future work.
Loading
Loading