Repository navigation
docs: architecture and reading guide - #110
Merged
Merged
Conversation
New contributors (and future me) have to reverse-engineer the split between the Node backend and the Go prober before anything else makes sense. This writes that down. ARCHITECTURE.md covers the mental model, a twelve-stop reading path through the code in dependency order, the check pipeline with the reasoning behind each concurrency guard, the data model grouped into five clusters, auth, the RSC frontend, the CLI/TUI/MCP surfaces, a feature map, transferable patterns, exercises, and an honest list of what's missing. Also corrects two stale README lines: the backend hasn't used node-cron since the Kafka scheduler landed, and the Go engine now probes TCP, DNS and keyword as well as HTTP. Every file path referenced in the guide was verified to exist.
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
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
ARCHITECTURE.md— a guided reading path through the codebase, and links it from the README.Understanding PulseOps currently means reverse-engineering why there's a Node backend and a Go prober talking over Kafka, before anything else clicks. This writes that reasoning down.
Contents
schema.prismaand ending atdocker-compose.yml, with a note on why each stop comes where it doesSKIP LOCKEDclaim, manual Kafka commits, Redis dedupMonitorCheckisBigIntand composite-indexedAlso
Corrects two stale README lines: the backend hasn't used node-cron since the Kafka scheduler landed, and the Go engine now probes TCP, DNS and keyword as well as HTTP.
Verification
Every file path referenced in the guide was checked to exist (34 paths + the dashboard route). Docs only — no code changes.