Repository navigation
docs: a new README with the logo and a screenshot - #38
Merged
Merged
Conversation
The README leads with a banner (the wordmark over the landing page's board), shows the landing page on a laptop and a phone, and gives the four landing cards with their drawings. The roadmap from the landing page and a section on the logo follow; the full feature table moves into a fold. scripts/build-readme-art.mjs draws the pictures in docs/assets/ from the running app, with the theme's colours written in, so they stay true to it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017arpabqDFhiyrYtcbQMw5J
A README presents the project; how the logo is drawn is in scripts/build-logo.py. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017arpabqDFhiyrYtcbQMw5J
The cards with drawings give way to a features table, the event a dart is stored as, the autoscorer's pipeline and the stack. It says what the code does today: the model runs on single-threaded WebAssembly, and voice scoring and offline use are still on the roadmap, so the README no longer claims them. The repository layout folds into the stack, and the card drawings and their script are gone. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017arpabqDFhiyrYtcbQMw5J
Both are planned (docs/07, A6 and A7) and neither is built, so they belong in what comes next rather than in the features. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017arpabqDFhiyrYtcbQMw5J
The autoscorer works; what it needs is more photos to train on, so the status note goes and the roadmap's last step is a sharper model rather than leaving experimental. Quick start follows the features, the dart's type leaves the walkthrough, and the data badge and the em dashes go. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017arpabqDFhiyrYtcbQMw5J
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017arpabqDFhiyrYtcbQMw5J
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
2 participants
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.
A README that presents the project with the new logo (#37), and then gets technical.
What's in it
The experimental-autoscoring note is gone. The README also no longer claims the app is an offline PWA, and says the model runs on single-threaded WebAssembly, which is what
vision/detector.tsdoes.Assets
docs/assets/banner.svganddocs/assets/screenshot.png.apps/web/scripts/build-readme-art.mjsregenerates both from the running app (npm run build && npm run preview, then the script). It needs Playwright, which is not a dependency of the project.Not in this PR
The landing page still has its own roadmap step "The autoscorer, out of experimental", and that text shows in the screenshot. Its "Your board, your device" card also says the app works offline. Changing either means changing the app (
apps/web/src/i18n/en.ts) and regenerating the screenshot.🤖 Generated with Claude Code
https://claude.ai/code/session_017arpabqDFhiyrYtcbQMw5J
Generated by Claude Code