[chat] No README.md in src/ or routes/ — violates AGENTS.md feature directory requirement #728

New issue

Closed

opened 2026-06-03 00:08:33 +02:00 by sleepy · 0 comments

sleepy commented

2026-06-03 00:08:33 +02:00

Owner

Problem

AGENTS.md requires:

Every feature directory MUST contain a README.md with: what it owns, what it does NOT own, key entry points, external dependencies, test locations.

The chat system spans src/ (chat_handler.py, chat_processor.py, chat_helpers.py, ai_interaction.py, context_compactor.py, action_intents.py, builtin_actions.py, session_actions.py, teacher_escalation.py, request_models.py) and routes/ (chat_routes.py, chat_helpers.py) — but neither directory contains a README.md.

Impact

No documentation of what the chat feature owns vs. doesn't own
No entry point documentation for new contributors
No test location mapping
Violates the AGENTS.md architectural baseline

Suggested fix

Create:

src/README.md documenting the chat domain: session management, message processing, context building, streaming, escalation
routes/README.md documenting the chat API surface and route-level helpers

## Problem AGENTS.md requires: > Every feature directory MUST contain a README.md with: what it owns, what it does NOT own, key entry points, external dependencies, test locations. The chat system spans `src/` (chat_handler.py, chat_processor.py, chat_helpers.py, ai_interaction.py, context_compactor.py, action_intents.py, builtin_actions.py, session_actions.py, teacher_escalation.py, request_models.py) and `routes/` (chat_routes.py, chat_helpers.py) — but neither directory contains a README.md. ## Impact - No documentation of what the chat feature owns vs. doesn't own - No entry point documentation for new contributors - No test location mapping - Violates the AGENTS.md architectural baseline ## Suggested fix Create: - `src/README.md` documenting the chat domain: session management, message processing, context building, streaming, escalation - `routes/README.md` documenting the chat API surface and route-level helpers

sleepy referenced this issue

2026-06-03 00:29:47 +02:00

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

sleepy referenced this issue from a commit

2026-06-03 16:07:27 +02:00

docs: add README.md for src/, routes/, services/memory/, services/search/, services/research/

sleepy referenced this issue from a pull request that will close it,

2026-06-03 16:07:53 +02:00

docs: add README.md for src/, routes/, services/memory/, services/search/, services/research/ #804

sleepy closed this issue

2026-06-03 23:12:31 +02:00