Skip to content

docs: pull the diff update guide out of the README - #180

Merged
floyd-soomgo merged 3 commits into
masterfrom
docs/diff-updates-guide
Aug 26, 2026
Merged

docs: pull the diff update guide out of the README#180
floyd-soomgo merged 3 commits into
masterfrom
docs/diff-updates-guide

Conversation

@floyd-soomgo

Copy link
Copy Markdown
Member

Why

The README carried the whole story of publishing a patch update across two sections: the build hook for each platform, how to archive what it exports, how to release against it, and what asset diffs need on top. That is deployment reference material, and it pushed the install guide out of the way.

What

  • docs/diff-updates.md (new) — the guide, in the order a reader meets it: the two kinds of difference a release can offer, exporting the embedded bundle (Android Gradle script, iOS build phase, archiving per binary version, releasing with --binary-bundle-path), then asset diff archives (the order a client tries archives in, and the three conditions that publish diffs).
  • docs/diff-updates.ko.md (new) — the same guide in Korean. The two link to each other from the top and match section for section: 7 headings, 5 code blocks, and the same table.
  • README.md — 640 → 526 lines. Section 4-2 is gone (asset diffs have nothing to do with the wrapper section 4 sets up) and section 6 becomes 6. Diff Updates (Optional), a single pointer to the guide. The advantages list at the top gains a Diff Updates entry, which it never had, linking to the same guide.
  • Inbound links follow the contentcli/README.md, cli/README.ko.md and both telemetry callback documents now point at the guide. The Korean documents point at the Korean guide.

Notes

  • Docs only. No source or test changes.
  • The last commit also fixes a few sentences, in both languages, that leaned on a demonstrative whose antecedent sat dozens of lines away or in a different table row — the record for a binary-patch-base.json named 56 lines earlier, that download for the table row above it.
  • Section 6 states that an asset diff only ships on a release that carries a binary patch, which matches the gate in cli/commands/releaseCommand/release.ts (binaryPatch && bundleDownloader && diffBaseCount > 0).
  • All 50 local markdown links across the seven touched files were checked against their targets, anchors included.
  • The two language versions are kept in step by hand, so a wording change in one needs the same change in the other.

Sections 4-2 and 6 between them carried the whole story of publishing a patch
update: the build hook for each platform, how to archive what it exports, how to
release against it, and what asset diffs need on top. Both leave the install
flow. Section 4-2 goes entirely, since asset diffs have nothing to do with the
wrapper section 4 sets up, and section 6 becomes a pointer named after the topic
rather than after one step of it.

docs/diff-updates.md holds the guide in the order a reader meets it: the two
kinds of difference a release can offer, exporting the embedded bundle, then
asset diff archives.

The advantages list at the top gains diff updates, which it never mentioned, and
links to the guide. Inbound links follow the content: cli/README.md,
cli/README.ko.md and both telemetry callback documents now point at it.
docs/diff-updates.ko.md carries the same sections, tables and examples as the
English guide, and the two link to each other from the top. Code comments are
in Korean, since the guide is read by Korean readers.

The Korean CLI README and the Korean telemetry document now point at it instead
of at the English guide, so a Korean reader stays in Korean.
Several sentences leaned on a demonstrative whose antecedent sat dozens of lines
away, in a different table row, or nowhere in the sentence at all: "the record"
for a binary-patch-base.json named 56 lines earlier, "that download" for the row
above it, a plural pronoun for a pair of nouns. Each one now names the thing.

Five in the Korean diff update guide, two in the Korean telemetry document, and
the two that read the same way in the English originals.
@floyd-soomgo

Copy link
Copy Markdown
Member Author

The new docs still need some work to make them easier to understand. Since it looks like this will take some time, I’ll merge this PR for now and work on improving them over the weekend.

@floyd-soomgo
floyd-soomgo marked this pull request as ready for review August 26, 2026 02:44
@floyd-soomgo
floyd-soomgo merged commit 32960c3 into master Aug 26, 2026
1 check passed
@floyd-soomgo
floyd-soomgo deleted the docs/diff-updates-guide branch August 26, 2026 02:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant