docs(server): add service-layer and api_endpoints code maps#135
Conversation
Add directory-local code-map READMEs for server/services and server/api_endpoints, and cross-link them from server/README.md. These are navigation aids for coding agents, following the repo's how_to_write_readme.md code-map conventions.
|
Caution Review failedPull request was closed or merged during review 📝 WalkthroughWalkthroughThis PR establishes server architecture documentation by introducing detailed README files for the API endpoints and services layers. The main server README is updated with navigation links, while two new README files document the API layer's request-handling pattern and the services layer's business-logic responsibilities. ChangesServer Architecture Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
What
Add directory-local code-map READMEs for the server's two largest undocumented layers, and cross-link them from the existing
server/README.md:reflexio/server/services/README.md— per-directory index of the business-logic layer (generation, evaluation, async extraction, search, persistence) with entry classes and key rules.reflexio/server/api_endpoints/README.md— theRequestContextcontract plus a per-file handler/helper map.reflexio/server/README.md— adds "Detailed Documentation" links to the two new maps (API Endpoints, Services, and See Also sections).Why
These two directories had no README, so an agent landing in
services/orapi_endpoints/had no local navigation. The new maps follow the repo'show_to_write_readme.mdcode-map conventions (concise, navigation-focused, NEVER/ALWAYS rules preserved) and complement — rather than duplicate — the workflow detail already inserver/README.md.Scope
Documentation only — no code or behavior changes.
Summary by CodeRabbit