docs: add an architecture overview (#930)#2169
Open
dhanvriddhi1gugu wants to merge 1 commit into
Open
Conversation
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.
Motivation
Issue #930 asks for more documentation — the maintainers noted the
docs/folder is thin and invited contributions. This PR adds an architecture overview as a starting point.Changes
Adds
docs/architecture.md: a high-level overview of exo's main components (master, api, worker, runner, election, routing) and the shared event-sourcing model (events → state ← commands, plus tasks), mapped to the currentsrc/exo/layout. Documentation only — no code changes.Why It Works
The structure follows the maintainer summary in #930. Every path it references exists in the tree (
src/exo/master/,src/exo/api/,src/exo/worker/runner/,src/exo/shared/election.py, andsrc/exo/shared/types/), and it links out todocs/api.mdandCONTRIBUTING.mdrather than duplicating them. It's intentionally high-level — happy to adjust scope, depth, or wording, and to expand the routing/RPC section once that area settles.Closes #930.