docs: clarify project structure [closes #5] - #6
Draft
robotyaga-gigachain[bot] wants to merge 1 commit into
Draft
Conversation
Co-authored-by: open-swe[bot] <open-swe@users.noreply.github.com>
Open
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.
Description
The repo layout and module responsibilities weren't documented, making it hard to understand how the pieces fit together. This adds a "Project structure" section to the README with an annotated file tree and a data-flow diagram (cameras → broker → workers → gui). No code or runtime behavior changed, so the hardcoded relative paths/imports remain intact.
Release Note
none
Test Plan
Closes #5
Made by Open SWE
References