docs: add project README with hand-drawn architecture diagrams#1
Merged
Conversation
Introduce a top-level README for the OrcaX client covering the client/engine split, the composed home feed (billboard, rows, Top 10, spotlight showcase), playback, and build/flavor notes. Diagrams under .github/assets are authored as SVG (no third-party artwork). Makes the self-hosted, bring-your-own-library scope explicit. Co-Authored-By: Claude Opus 4.8 <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 this does
Adds a top-level
README.mdfor the OrcaX client — the repo currently has none, so the GitHub front page shows no overview.The README covers:
Diagrams
Four illustrations under
.github/assets/(thedocs/folder is gitignored, so assets live there instead). All are authored by hand as SVG — geometry and text only, no third-party artwork and no platform logos.Notes
🤖 Generated with Claude Code