Repository navigation
docs(readme): product README with screenshots; developer docs move to docs/DEVELOPMENT.md - #167
Merged
Merged
Conversation
… docs/DEVELOPMENT.md The README now introduces YGO Alpha from a player's point of view: what each feature does, with dark-mode screenshots of the inventory, quick entry, catalog, deck editor, assistant, tournaments, public profile and the mobile layout, followed by a short quick start, the stack, and credits. The previous README moves unchanged to docs/DEVELOPMENT.md (links adjusted for the new location) with a short intro; its built-in format list now names Classic Plus (ADR 0022). The disclaimer stays at the top of the README (ADR 0018) and the README keeps the YGOPRODeck and ygoresources credits (ADR 0015). Screenshots were taken from a demo account with made-up data, 2000px WebP (~1.5 MB total). Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
dinooo13
force-pushed
the
docs/product-readme
branch
from
September 29, 2026 19:19
2df36ca to
7a2a6c6
Compare
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.
Summary
Replaces the developer-oriented README with a product-focused one: what YGO Alpha does for a player, with dark-mode screenshots of every major feature. The existing technical content moves to
docs/DEVELOPMENT.md.Roadmap phase / item
Documentation, across phases 1–5 (it presents the features the roadmap has delivered so far).
Changes
README.md: tagline, disclaimer at the top (ADR 0018), then feature sections with screenshots: inventory, quick entry, catalog, deck editor, formats and legality, assistant, tournaments, sharing and profiles, mobile/PWA. Ends with a short quick start (pnpm and Docker), the stack, doc links and credits (YGOPRODeck, ygoresources, ADR 0015).docs/DEVELOPMENT.md: the previous README, with relative links fixed for its new location and a short intro. Its built-in format list now also names Classic Plus (ADR 0022). Nothing else is rewritten.NUXT_INVITE_CODE,NUXT_ADMIN_TOKEN, the token-based catalog sync, the public-host note) are carried over intodocs/DEVELOPMENT.md. The new README's Docker quick start writes both to.env, because compose only reads variables other than the secret and URL from there, and loads the catalog with the admin token (ADR 0027 expects the README's deployment notes to mention the invite code).docs/screenshots/*.webp: 8 desktop shots (1440×900 @2x, downscaled to 2000px) and 3 phone shots, about 1.5 MB total. Taken from a production build on a copy of the database, with a fresh demo account (@yugi) and made-up collection, decks, wishlist and tournament. No real user data appears.Test plan
README.mdanddocs/DEVELOPMENT.mdresolves🤖 Generated with Claude Code