Repository navigation
docs: modernize READMEs with current features and product screenshots - #121
Merged
Merged
Conversation
The READMEs predated the app market, creator profiles, comments/ratings, tags, the creator-written About section, HTML upload mode, and per-device history. Rewrite all 9 language versions around the current feature set, embed the 8 new product screenshots as a guided journey, and add 4 SVG figures (pipeline, stats, community identity, package sizes). Remove the orphaned assets/screenshot-*.png. Numbers are measured from the repo (336 tests, 35 endpoints, 9 languages, CI py3.10-3.12). Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.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.
Fixes #120
Summary
README.mdand all 8 localized READMEs (docs/README.*.md) to document the current feature set: app market, fingerprint profiles, creator attribution, comments & ratings, tags, creator-written About section (text + up to 3 auto-compressed images), HTML upload mode, per-device history, R2 offload, auto-cleanup.docs/assets/shots/arranged as a guided journey: landing → config (about/platforms/publish) → download page → about fold → market → history.docs/assets/: pipeline, at-a-glance stats, community identity flow, measured package sizes.assets/screenshot-1..4.png(old UI, no longer referenced).Test plan
validate_docs.py README.md docs/README.zh.md --assets docs/assets— all checks pass (valid SVG XML, no broken/orphaned refs)pytest tests/— 336 passedsrc/hrefin all 9 READMEs resolves on disk and every<img>has descriptive alt textGenerated with Devin