docs: add architecture section to API README#404
Merged
Conversation
Document all connected services and sibling repos: a Mermaid diagram, a Connected Services table (frontends, datastores, Moodle, OpenAI, R2), and an Analysis Workers subsection (sentiment, topic-model, embeddings, recommendations) with repo links, BullMQ queues, and env vars. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds an Architecture section to
api.faculytics/README.mddocumenting every connected service and sibling repo of this backend. Documentation-only change; no code touched.What's included
app.faculytics,admin.faculytics) → the NestJS API, plus its connections to PostgreSQL (+pgvector), Redis, Moodle, OpenAI, Cloudflare R2, and the async analysis workers (dashed = BullMQ → HTTP dispatch).CtrlAltElite-Devsorg.../CLAUDE.mdfor the full multi-project overview.Verification
Preview the README on GitHub to confirm the Mermaid diagram renders and table links resolve.