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

Open

sleepy wants to merge 0 commits from fix/add-readmes-728-742-782 into main

sleepy commented

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

Owner

Closes #728, closes #742, closes #782.

Per AGENTS.md, every feature directory must have a README.md documenting:

What the directory owns
What it does NOT own
Key entry points
External dependencies
Test locations

Each README was written after reading the actual source files to ensure accuracy.

Files added

File	Coverage
`src/README.md`	Agent loop, chat domain, LLM core, tools, embeddings/RAG, research, background jobs, auth/security, upload, app lifecycle, integrations
`routes/README.md`	All 48 route modules and 6 helper modules documented with API prefixes and purposes
`services/memory/README.md`	MemoryManager, MemoryVectorStore, SkillsManager, Skill format, memory/skill auto-extractors
`services/search/README.md`	SearchService, 6 providers, query enhancement, ranking, content fetching, caching, analytics
`services/research/README.md`	ResearchService, ResearchHandler, ResearchResult/ResearchSource dataclasses

Closes #728, closes #742, closes #782. Per AGENTS.md, every feature directory must have a README.md documenting: - What the directory owns - What it does NOT own - Key entry points - External dependencies - Test locations Each README was written after reading the actual source files to ensure accuracy. ## Files added | File | Coverage | |------|----------| | `src/README.md` | Agent loop, chat domain, LLM core, tools, embeddings/RAG, research, background jobs, auth/security, upload, app lifecycle, integrations | | `routes/README.md` | All 48 route modules and 6 helper modules documented with API prefixes and purposes | | `services/memory/README.md` | MemoryManager, MemoryVectorStore, SkillsManager, Skill format, memory/skill auto-extractors | | `services/search/README.md` | SearchService, 6 providers, query enhancement, ranking, content fetching, caching, analytics | | `services/research/README.md` | ResearchService, ResearchHandler, ResearchResult/ResearchSource dataclasses |

sleepy added 1 commit

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

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

Addresses issues #728, #742, #782.

Per AGENTS.md, every feature directory must have a README.md documenting:
- What the directory owns
- What it does NOT own
- Key entry points
- External dependencies
- Test locations

Each README was written after reading the actual source files to ensure accuracy.

This branch is already included in the target branch. There is nothing to merge.

View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u origin fix/add-readmes-728-742-782:fix/add-readmes-728-742-782

git switch fix/add-readmes-728-742-782

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git switch main

git merge --no-ff fix/add-readmes-728-742-782

git switch fix/add-readmes-728-742-782

git rebase main

git switch main

git merge --ff-only fix/add-readmes-728-742-782

git switch fix/add-readmes-728-742-782

git rebase main

git switch main

git merge --no-ff fix/add-readmes-728-742-782

git switch main

git merge --squash fix/add-readmes-728-742-782