docs: add contributor architecture overview - #447
Draft
pdsarin wants to merge 1 commit into
Draft
Conversation
Add docs/ARCHITECTURE.md mapping the codebase for contributors: the collection (write) vs. dashboard (read) halves, the API request lifecycle, the multi-backend query layer, the core data model, and a "where do I make a change?" reference table. Link it from the README. Run-on: Niteshift Staging 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.
What
Adds
docs/ARCHITECTURE.md— a contributor-focused map of the Umami codebase — and links it from the README.Why
"Explain what this repo does" is a recurring onboarding question. This captures the answer in the repo itself so new contributors can orient quickly without reading the full source.
Contents
parseRequest → checkAuth → permissions → query → responsepattern used acrosssrc/app/api.runQuery()abstracts over Prisma / raw SQL / ClickHouse, plus the core Prisma data model.Notes
src/app,src/queries,prisma/schema.prisma,package.json).🤖 Generated with Claude Code
🌒 Run on Niteshift: View Task