Repository navigation
docs: add an architecture page with the package layers - #21
Merged
Merged
Conversation
…nd child processes
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.
Stacked on #20.
Adds
docs/architecture.md, linked fromdocs/README.md. It holds one Mermaid diagram of the package layers: storage at the bottom, the service layer, the front ends (CLI, board, MCP server, web server) and the executor beside them. A short page explains each box and where the boundaries are.Every solid arrow is an import listed by
go list -f '{{.ImportPath}}: {{join .Imports " "}}' ./.... The dashed arrows mark process boundaries, where the board and the cockpit startpmas a child process instead of importing the executor. The leaf helpers are listed in text to keep the picture on one screen.Docs only.