docs: send readers to the SDK versions page for the version to use - #36
Merged
Conversation
Both READMEs write the CDN url with a `<version>` placeholder, which only works if the reader has somewhere to resolve it. The bucket cannot be listed without credentials, so until now there was nowhere: the legacy README left the reader to guess, and the root README named `v0`, a path that has not been updated since v0.1.0 moved releases into a directory per release. It still resolves, which is the part that makes it harmful — a page loading it gets an old bundle and no signal that anything is wrong. Both now point at the SDK versions page on the docs site, which carries the lookup link for every platform's registry, and the root README says plainly that the v0 path is frozen.
A .CHANGELOG.md.swp left behind by a crashed editor was committed and has been in the tree since. Remove it, and ignore the pattern so the next crash does not put another one there.
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.
Both READMEs write the CDN url with a
<version>placeholder. That only works if the reader has somewhere to resolve it, and the bucket cannot be listed without credentials — so until now there was nowhere.What changes
packages/rum-legacy/README.md— keeps the placeholder, and now says where to look the version up.README.md— the CDN section namedhttps://static.flashcat.cloud/browser-sdk/v0/flashcat-rum.js. That path has not been updated since v0.1.0 moved releases into a directory per release; the file sitting there is from 2025-08-29 and carries no version string, where the current bundle reports"0.1.0". It still returns 200, which is what makes it harmful: a page loading it gets an old bundle with no signal that anything is wrong. The section now uses the same<version>form as the legacy README, points at the same lookup page, and states plainly that the v0 path is frozen.Both link to a new SDK versions page on the docs site, which carries the version lookup link for every platform's registry (npm, Maven Central, CocoaPods, ohpm, pub.dev) plus the CDN url scheme. Written so that no version number is hardcoded anywhere — the page links to registries rather than restating what they say, so it cannot go stale.
A second commit removes
.CHANGELOG.md.swp, an editor swap file that was committed at some point, and ignores the pattern.Merge order
The docs page is a separate PR in
flashduty-docs. Merge that one first — until it deploys, the links added here 404.Verification
prettier --checkpasses on both READMEs.<script>snippets still finds and passes 2 snippets; no snippet was touched.