Repository navigation
fix: move v6 migration guide to Migration guides and fix examples - #1348
Conversation
…ken examples - Move the v6 guide from In-depth to a new Migration guides section (/migration/v6), with an overview of all migration guides. The old /in-depth/migration-v6 URL redirects to the new page. - Make the guide the complete list of breaking changes between 5.20.2 and 6.0.0, and fix its errors: the Alpine SVG properties that keep their names, the .ui-* class mapping, the -columns-right band wrappers, validateColumnFreeze() (never existed), the removed clipboard options, the SortableJS instances that were returned, and horizontal rendering (it was synchronous in 5.20.2). - Fix the same errors in the pinning guide's migration table. - Publish lib/ with the examples on GitHub Pages: the examples that load third-party scripts from ../lib (both Sparkline examples, Select2, JSONP, row reordering) failed there with a 404. - Restore Sparkline 2.1.2 in the async post render cleanup example, which is what the page describes and demonstrates. - Make the examples' home link relative, so it works under /SlickGrid/. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1348 +/- ##
=======================================
Coverage 93.41% 93.41%
=======================================
Files 34 34
Lines 13519 13519
Branches 4091 4091
=======================================
Hits 12629 12629
Misses 686 686
Partials 204 204 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
@6pac-ai I found another small problems with the docs, Vitepress seems to be converting the links to all lowercase and some of the function links are now wrong, for example v6 migration has a link to @6pac so I was curious, can I converse with @6pac-ai or do you need to approve it to get going? |
|
OK, will feed that back in. Regarding conversing with the AI, at the moment, I just tell it to read comments and react to them. I've asked it, and it can set up a scheduled job that runs every minute or so, which would allow it to reply. But honestly, I'm not really okay with that: AI is still in its fairly early days, and I'm not sure how far prompt injection could go. Thinking about it more, I suppose I could just restrict it to comments on your account that it reacts to. |
indeed keep it as-is, it's not necessary and was exactly what I expected. There are things that I don't want AI to have to much control over (like my bank account) and that might be another one of them.
yeah exactly. I don't need any special privileges, we are mainly done with v6, it's released and anything is small little things here and there that can definitely wait a little longer... so keep it as it is, I'm totally fine with current behavior and just wanted to confirm ;) |
VitePress 2 runs the #hash of every internal link through the heading slugify, which lowercases it, so links such as /reference/grid#m-updateColumns were rendered as #m-updatecolumns and missed the Reference ids, which are the member names. Keep `prefix-memberName` hashes as written and slugify everything else as before; every heading id on the site is unchanged. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…--slick-* #1317 renamed every Alpine variable to the slick- prefix but missed the three CSS properties generated by createSvgStyle(): --alpine-group-expanded-icon-svg, --alpine-group-collapsed-icon-svg and --alpine-percent-complete-picker-icon-svg. They are now --slick-*, which is also the name example-grouping.html already uses for its override. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
@ghiscoding thanks, you're right on both points. I pushed a fix for each: Lowercased reference links: 8b3e420. This wasn't limited to the migration guide. VitePress 2's link plugin runs the The fix is a custom The three The guide no longer lists these three as an exception. It now notes that 6.0.0 itself still shipped them with the |
|
@6pac I made a small change to the docs after Claude, I'm ok with the rest of the PR. Feel free to merge if you're happy with it too |
|
@6pac-ai can you rename the PR since I think it should be rename as a "fix" PR because it includes missed |
Summary
Moves the v6 migration guide into a new Migration guides section of the docs and makes it the complete, authoritative list of breaking changes between 5.20.2 and 6.0.0. Also fixes the examples that are broken on GitHub Pages, including the Sparkline async post render cleanup example.
Why
../lib/fails, because the Pages workflow copiesexamples/but notlib/. The Sparkline cleanup example throws$(...).empty(...).sparkline is not a function, and the charts stay at "wait..."./examples/index.html, which is a 404 under/SlickGrid/.Changes
docs/migration/section, in the top nav and with its own sidebar.index.mdlists all migration guides (v3 to v6), andv6.mdis the v6 guide./in-depth/migration-v6is kept as a stub page that redirects to/migration/v6, so existing links (release notes, README, discussions) keep working.dist/on GitHub, removed exports)mixinDefaults--alpine-*SVG properties that keep their names.ui-*→.slick-*mapping-columns-rightband wrappers, which still existvalidateColumnFreeze(), which never existedgetSetupColumnReorder()actually returnedvalidateColumnFreeze(), classes andtrigger()errors; they are fixed.docs.ymlcopieslib/into the Pages site and rebuilds onlib/**changes.example10a-async-post-render-cleanup.htmlpage loads Sparkline 2.1.2 with jQuery 3.7 again, which is what the page describes and demonstrates. Version 5.0 had replaced it with example 10's Sparkline 1.x + jquery-migrate block. Its title is fixed too../index.html).Validation
vitepress/:npm run links(626 internal links OK),npm run drift(0 undocumented) andDOCS_BASE=/SlickGrid/ npm run docs:buildall pass./SlickGrid/and checked it in a browser:/SlickGrid/migration/v65.20.2and6.0.0tags.npm run build), in the browser:lib/jquery.sparkline.min.js,lib/select2.jsandlib/jquery.jsonp-2.4.min.js.Comments
docs/data/api.jsonwas regenerated by the docs build. I left it out because the only changes were the timestamp and a local path.AI / LLM assistance
Checklist
🤖 Generated with Claude Code