docs: pre-open-source documentation review#9
Merged
Conversation
- CONTRIBUTING: replace outdated 'No tests yet' with real pytest instructions - ARCHITECTURE: fix env var name (RETROHOST_WEBRTC_HOST -> HOMEGAMES_WEBRTC_HOST) - ARCHITECTURE: fix CIFS mount point (/mnt/retrohost-roms -> /mnt/homegames-roms) - ARCHITECTURE: add tests/, pytest.ini and compose.yml to project structure - README: fix broken TOC anchor for Quick Start section - README: replace commercial ROM examples with free homebrew (Magic Castle, Super Boss Gaiden) with official download links - README: document docker compose as an alternative to docker run - Replace <repo-url> placeholders with the real repository URL - gitignore personal notes file Co-Authored-By: Claude Fable 5 <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.
Documentation review before opening the project to the community.
Fixes
tests/unit/; added instructions to run it and pointed at the least-covered modules (services/player.py,services/storage.py).RETROHOST_WEBRTC_HOST→HOMEGAMES_WEBRTC_HOST(the one actually read bydocker-entrypoint.sh)./mnt/retrohost-roms→/mnt/homegames-roms(matchesconfig.py).tests/,pytest.iniandcompose.ymlto the project structure listing.x86_64).docker compose up -das an alternative todocker run.<repo-url>placeholders (5 occurrences) with the real repository URL..gitignore.🤖 Generated with Claude Code