Rework documentation versioning, flatten ROS, rename to software-tools - #24
Merged
Merged
Conversation
ebarnett3
requested changes
Oct 1, 2026
ebarnett3
left a comment
ebarnett3
left a comment
There was a problem hiding this comment.
Request changes. Blocking: the auto-cut workflow can't merge (cut-versions.yml), removed pages 404 with no redirects (docusaurus.config.js), and version switching crashes or freezes the page (src/theme/Layout/index.jsx). Details inline.
Verified locally on 7193554: npm run test:unit, npm run build and npm test pass, and CI is green. I also manually and automatically tested the built site: all 27 sidebar pages navigate client-side cleanly, so the cross-instance routing fix works. Banners, tag-rewritten GitHub links, product tables, intro links, mobile and dark mode are all fine.
Other notes, not tied to a diff line:
- Stable ROS pages: the robotiq/ros
v1.1.0README links#migrating-from-picknik-ros2_robotiq_gripper, a broken anchor (build warns). It's fixed upstream onmainand clears on the next tag. The install steps there alsogit clonewith no-b v1.1.0, so following the "Stable" instructions gets youmain. Adaptive grippers/ROSandTactile Sensor/ROSrender the identical robotiq/ros README. Intended?- Every build now runs sync + Doxygen + generate-tools-table twice (Latest + Stable). Fine at today's CI time (~1m42s).
- The code comments are very long (e.g.
cut-version.js~L769-792, therouteBasePathblock). Much of the "confirmed the hard way" narrative would sit better in commit/PR history.
|
@bcastets-robotiq did you forget to push your changes? |
…en ROS, rename to software-tools - Stop committing Stable's frozen snapshot; materialize it from source on every build (scripts/ensure-stable-version.js), the same pipeline as Development (main), driven by the tiny committed software-tools-stable.json tag map. - Rename versioned-tools/ -> software-tools/ sitewide. - Omit an empty category section (heading included) instead of a placeholder message. - Collapse the per-distro/per-generation ROS pages into a single ROS page per product; sync Adaptive grippers' and Tactile Sensor's from robotiq/ros and register them in the Stable/Development (main) switcher. Force Torque Sensor/EPick keep hand-authored third-party ROS content. - Rename the "Latest" version label to "Development (main)" sitewide, read dynamically by DocVersionBanner instead of hardcoded. - Automate cutting Stable/Previous versions and a daily auto-cut CI job, using the robotiq-readme-bot App token so the PR it opens can actually pass required checks and auto-merge. - Fix a version-switch crash/freeze loop (React #185), a sitewide-root fallback instead of the nearest ancestor page on a version switch, and a stale dropdown label on first load. - Add redirects for pages this rework removes outright, instead of 404ing. - Guard against submodules shared by multiple versioned tools disagreeing on tag; stop undoing `npm run preview`/`SKIP_SUBMODULE_RESET=1`; fix a stale-skip bug in the Stable materialization cache key. - Skip the version banner for a registered tool with no recorded tag. - Derive versioned-tools.js and sidebars.software-tools.js's activeItems from external-jobs.js instead of hand-maintaining both separately. - Update docs/contribute/* throughout to match. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
bcastets-robotiq
force-pushed
the
versioning-rework
branch
from
October 2, 2026 17:46
3ceff8f to
7313aa4
Compare
Collaborator
Author
ebarnett3
approved these changes
Oct 2, 2026
ebarnett3
left a comment
ebarnett3
left a comment
There was a problem hiding this comment.
Re-verified on 7313aa4: all review findings addressed. Local build + 45 unit tests + npm test pass; browser-tested the version switching (no more #185 crash/freeze, dropdown both ways, intro→product SPA nav, API-page fallback), the "Development (main)" label, and the old-URL redirects. Remaining broken ROS anchor is upstream in robotiq/ros and clears on its next tag.
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
2 participants
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
versioned-tools/->software-tools/.ROSpage per product; sync Adaptive grippers/Tactile Sensor fromrobotiq/ros, versioned like every other driver. Force Torque Sensor/EPick keep hand-authored third-party content.Test plan
npm run test:unitnpm run build(Latest + a fresh Stable re-materialization)npm test🤖 Generated with Claude Code