DEV-2104: make docs examples bucket-aware#66
Open
demtario wants to merge 1 commit into
Open
Conversation
Reload clean docs examples from the selected version while preserving edited work with a compatibility warning.
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using default effort and found 2 potential issues.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Want higher recall? High effort reviews run extra passes and find more bugs. A team admin can switch effort levels in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 3277a52. Configure here.
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
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
Task: https://app.clickup.com/t/9015210959/DEV-2104
Test plan
pnpm testpnpm --filter @handsontable/demo-authoring run typecheckpnpm --filter @handsontable/demo-authoring buildpnpm e2e -- e2e/docs-examples.spec.ts(10 passed, 1 live test skipped by design)18.0tonextand confirmed the rendered bucket content changedBase dependency
The generated
18.0andnextartifacts are already merged intofeature/DEV-2099_Versioned-docs-examplesvia PR #65.Note
Medium Risk
Touches core playground load/version-switch flows and async race handling; wrong bucket logic could show mismatched API examples, but behavior is guarded with explicit errors, no silent fallback to
next, and broad E2E coverage.Overview
Documentation examples in the playground are now loaded from version-specific buckets (
major.minorornextwhen the selected version matches npm’sdist-tags.next), instead of a single flat catalog.Authoring behavior: After versions resolve from the API, the app derives a bucket, fetches that bucket’s manifest (as the “does this version have docs?” check), and drives the cascader from those entries only. Changing Handsontable version on a clean docs workspace reloads the same
?docs=path from the new bucket; with unsaved edits, source is kept, dependencies/CSS are re-pinned, and a compatibility warning is shown. Missing buckets or paths block the preview (blank iframe) with recoverable errors rather than falling back to starters or the wrong API.Supporting changes:
docs-catalogand caches are keyed by bucket;deriveDocsBucketCandidateis shared from demo-runtime; pipeline smoke and Playwright tests cover bucket layout and version-switch regressions.Reviewed by Cursor Bugbot for commit 3277a52. Bugbot is set up for automated code reviews on this repo. Configure here.