[docs] Add missing README.md to feature directories (#782) #858

Closed

sleepy wants to merge 0 commits from fix/missing-readmes-782 into main

sleepy commented

2026-06-03 22:39:33 +02:00

Owner

Summary

Closes #782.

Issue #782 reported three directories missing README.md:

Directory	Status
`services/search/`	Already had `README.md` — no change needed
`services/research/`	Already had `README.md` — no change needed
`src/search/`	Missing — added in this PR

What was added

src/search/README.md — documents the canonical search implementation following AGENTS.md conventions:

What the directory owns (all search modules, their purposes)
What it does NOT own (routes, SearchService facade, LLM, research, RAG)
Key entry points (public functions and their signatures)
External dependencies (httpx, beautifulsoup4, settings)
Test locations

Verification

README follows the AGENTS.md requirement
No TODO/FIXME added
Documentation only — no code changes

## Summary Closes #782. Issue #782 reported three directories missing `README.md`: | Directory | Status | |-----------|--------| | `services/search/` | Already had `README.md` — no change needed | | `services/research/` | Already had `README.md` — no change needed | | `src/search/` | **Missing** — added in this PR | ### What was added `src/search/README.md` — documents the canonical search implementation following AGENTS.md conventions: - What the directory owns (all search modules, their purposes) - What it does NOT own (routes, SearchService facade, LLM, research, RAG) - Key entry points (public functions and their signatures) - External dependencies (httpx, beautifulsoup4, settings) - Test locations ### Verification - [x] README follows the AGENTS.md requirement - [x] No TODO/FIXME added - [x] Documentation only — no code changes

sleepy added 1 commit

2026-06-03 22:39:33 +02:00

[docs] Add missing README.md to src/search/ (#782 ) b9b32e0537

Only src/search/ was missing its README.md. The services/search/ and
services/research/ directories already had theirs.

The new README follows the AGENTS.md convention: what the directory owns,
what it does NOT own, key entry points, external dependencies, and test
locations.

sleepy referenced this pull request

2026-06-03 22:39:53 +02:00

[search/research/infrastructure] Missing README.md in services/search/, src/search/, services/research/ — violates AGENTS.md feature directory requirement #782

sleepy closed this pull request

2026-06-04 11:42:27 +02:00