docs: move the telemetry callback reference out of the README - #179
Merged
Conversation
The README's telemetry section carried the whole callback reference: every signature, the UpdateArchiveResult fields, and the fallback reasons. It now keeps a short paragraph and a link, and docs/telemetry-callbacks.md holds the reference - the callback table, what onUpdateArchiveResult reports, the UpdateArchiveResult and UpdateArchiveAttempt fields, the fallbackReason words, and why a fallback is not a failed update. What the README keeps of the archives is what the install guide needs: a table of the three archives in the order a client tries them, and the two exceptions to that order.
docs/telemetry-callbacks.ko.md carries the same sections and tables as the English reference, and the two link to each other from the top.
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.
Why
The README's telemetry section had grown into the full callback reference: every signature, the
UpdateArchiveResultfields, and the fallback reasons. That is reference material, and it pushed the install guide out of the way.What
README.md— section 4-1 keeps a short paragraph and a link. Section 4-2 keeps only what the install guide needs: a table of the three archives in the order a client tries them, and the two exceptions to that order.docs/telemetry-callbacks.md(new) — the reference itself: the callback table, whatonUpdateArchiveResultreports, theUpdateArchiveResultandUpdateArchiveAttemptfields, thefallbackReasonwords, and why a fallback is not a failed update.docs/telemetry-callbacks.ko.md(new) — the same reference in Korean. The two versions link to each other from the top, and they match section for section: 8 headings, 4 code blocks, and tables of 7 / 5 + 4 / 8 rows in both.Notes
#4-codepush-ify-your-appand#4-2-asset-diff-archivesin the README,#codepushoptions,#codepushnotifyappreadyand#syncstatusindocs/api-js.md, and#what-onupdatearchiveresult-reportsin the new document.