Skip to content

Sync the documentation fixes from main into publish - #37

Merged
Fiona2016 merged 5 commits into
publishfrom
main
Sep 1, 2026
Merged

Sync the documentation fixes from main into publish#37
Fiona2016 merged 5 commits into
publishfrom
main

Conversation

@Fiona2016

Copy link
Copy Markdown
Collaborator

Brings publish up to date with the five documentation commits that landed on main.

Release tags are cut on publish, so anyone who checks out a release tag reads the READMEs as they stand on this branch. Until this merge, that meant:

File on publish What it said Reality
packages/rum-legacy/README.md browser-sdk/v0.0.8/... Never released — 404
README.md browser-sdk/v0/flashcat-rum.js Frozen since v0.1.0; serves a bundle from 2025-08-29

After this merge both carry the <version> form and link to the SDK versions page on the docs site, and the root README states that the v0 path is no longer updated.

Also included: removal of a committed editor swap file and a *.swp ignore rule, and the v0.0.8 example in the sync-bundles.js usage comment.

Merges cleanly — five files, no conflicts, verified locally before opening this.

The bundle urls named v0.0.8, a version that was never released. This
build first shipped in v0.1.0, so both of those urls 404 and a reader
copying them gets nothing. Use a <version> placeholder rather than a
literal that goes stale on the next release, and say which release the
legacy bundle starts at, since the directories of earlier ones exist
but hold no fc-rum-legacy.js.

The sync-bundles example passed `v0`, a directory the release tooling
never writes: deploy-oss.js uploads under the full version, and what
sits at v0 predates the legacy build entirely. The command therefore
fails on fc-rum-legacy.js. Drop the arguments so the script takes the
version from lerna.json and stays correct release to release, and note
that its arguments are positional, so an output directory cannot be
given without naming a version first.
docs(rum-legacy): point the CDN examples at paths that exist
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.
…rsions-page

docs: send readers to the SDK versions page for the version to use
@Fiona2016
Fiona2016 merged commit b994820 into publish Sep 1, 2026
12 checks passed
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