docs(readme): reframe as demo + starter, drop verbatim copy of upstream#16
Merged
docs(readme): reframe as demo + starter, drop verbatim copy of upstream#16
Conversation
The example README was a verbatim duplicate of the upstream README — same intro, same Setup section, same everything. That gives a visitor zero signal about what makes the example different from the template, and forces every doc fix to land in two places (and stay synchronized). This rewrite: - **Top**: explains what the live demo IS (history of khao pad as a 5-essay series in EN + TH) and what's wired up (every milestone through v2.0). - **What's different from upstream**: enumerates the 4 reskinned files, the seed content, the example-specific i18n keys, and the wrangler config. Future cherry-pick PRs reference the same list. - **Two paths to use it**: A) start clean from upstream template (recommended for new projects); B) fork this example if you want the paypers brand polish as a starting design. Step-by-step for each. - **Staying in sync with upstream**: the standard cherry-pick recipe + the two manual rules (field-merge i18n; preserve the 4 paypers files). Encoded the same lesson that's been in personal memory since the v1.6 cherry-pick wiped the reskin. - **Architecture/bindings/deployment**: linked to upstream README instead of duplicating. One source of truth. Net: 299 → 95 lines, zero duplicated content with upstream. Co-Authored-By: Claude Opus 4.7 <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.
Summary
The example README was a verbatim duplicate of upstream — same intro, same Setup, same everything. Zero signal about what made the example different from the template; every doc fix had to land in two places.
Rewrite
Net change
299 lines → 95 lines. Zero duplicated content with upstream.
🤖 Generated with Claude Code