website: prepare versioning for v2 release#455
Open
abetomo wants to merge 1 commit intoenactic:mainfrom
Open
Conversation
We're getting ready to release v2 soon. `npm run docusaurus docs:version v1` was run to apply versioning. Everything except `docusaurus.config.ts` was automatically generated. The only manual change was to `docusaurus.config.ts`. In `docusaurus.config.ts`, version switching is configured, and v1 is set as the default documentation until everything is ready.
|
Preview: https://abetomo.github.io/openarm See https://github.com/enactic/openarm/blob/main/website/README.md#pull-request-and-preview how to configure preview on fork. |
Contributor
Author
|
Docusaurus versioning document: |
There was a problem hiding this comment.
Pull request overview
Prepares the Docusaurus website for an upcoming v2 docs release by enabling documentation versioning, freezing the current docs as v1, and exposing v2 (Preview) via the version dropdown.
Changes:
- Added Docusaurus docs versioning configuration (v1 as default, v2 as “current/preview”) and enabled the docs version dropdown in the navbar.
- Added the generated
versions.json, versioned sidebar, and a full snapshot of v1 docs underwebsite/versioned_docs/version-v1/.
Reviewed changes
Copilot reviewed 71 out of 71 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| website/versions.json | Registers v1 as a versioned docs snapshot for Docusaurus. |
| website/versioned_sidebars/version-v1-sidebars.json | Generated sidebar definition for the v1 doc set. |
| website/versioned_docs/version-v1/teleop/vr.mdx | v1 snapshot of the VR teleoperation docs page. |
| website/versioned_docs/version-v1/teleop/leader-follower/unilateral-control.md | v1 snapshot of unilateral leader-follower control instructions. |
| website/versioned_docs/version-v1/teleop/leader-follower/setup-guide.md | v1 snapshot of leader-follower teleop setup instructions. |
| website/versioned_docs/version-v1/teleop/leader-follower/index.mdx | v1 snapshot of leader-follower teleop overview/index page. |
| website/versioned_docs/version-v1/teleop/leader-follower/bilateral-control.md | v1 snapshot of bilateral control instructions. |
| website/versioned_docs/version-v1/teleop/leader-follower/category.json | v1 snapshot category metadata for teleop/leader-follower. |
| website/versioned_docs/version-v1/teleop/category.json | v1 snapshot category metadata for teleop. |
| website/versioned_docs/version-v1/software/ubuntu/index.mdx | v1 snapshot of Ubuntu install guide. |
| website/versioned_docs/version-v1/software/ubuntu/dual-boot.mdx | v1 snapshot of Windows dual-boot instructions. |
| website/versioned_docs/version-v1/software/ubuntu/docker.mdx | v1 snapshot of running Ubuntu/dev via Docker guidance. |
| website/versioned_docs/version-v1/software/ubuntu/category.json | v1 snapshot category metadata for software/ubuntu. |
| website/versioned_docs/version-v1/software/setup/index.md | v1 snapshot of the software setup landing page. |
| website/versioned_docs/version-v1/software/setup/category.json | v1 snapshot category metadata for software/setup. |
| website/versioned_docs/version-v1/software/setup/5-run-demo.mdx | v1 snapshot of “run demo” setup step. |
| website/versioned_docs/version-v1/software/setup/4-motor-config.mdx | v1 snapshot of motor configuration setup step. |
| website/versioned_docs/version-v1/software/setup/3-configure-test.mdx | v1 snapshot of motor communication test step. |
| website/versioned_docs/version-v1/software/setup/2-can-setup.mdx | v1 snapshot of SocketCAN setup step. |
| website/versioned_docs/version-v1/software/setup/1-motor-id.mdx | v1 snapshot of motor ID configuration step. |
| website/versioned_docs/version-v1/software/ros2/install.mdx | v1 snapshot of ROS 2 installation guide. |
| website/versioned_docs/version-v1/software/ros2/control.mdx | v1 snapshot of ROS 2 control guide. |
| website/versioned_docs/version-v1/software/ros2/category.json | v1 snapshot category metadata for software/ros2. |
| website/versioned_docs/version-v1/software/index.md | v1 snapshot of software docs index. |
| website/versioned_docs/version-v1/software/description.mdx | v1 snapshot of robot description package docs. |
| website/versioned_docs/version-v1/software/controls.md | v1 snapshot placeholder for controls docs. |
| website/versioned_docs/version-v1/software/can.mdx | v1 snapshot of CAN library docs. |
| website/versioned_docs/version-v1/software/category.json | v1 snapshot category metadata for software. |
| website/versioned_docs/version-v1/simulation/mujoco.mdx | v1 snapshot of MuJoCo simulation docs. |
| website/versioned_docs/version-v1/simulation/isaac-lab.mdx | v1 snapshot of Isaac Lab simulation docs. |
| website/versioned_docs/version-v1/simulation/category.json | v1 snapshot category metadata for simulation. |
| website/versioned_docs/version-v1/purchase/index.mdx | v1 snapshot of “Buying OpenArm” page. |
| website/versioned_docs/version-v1/purchase/category.json | v1 snapshot category metadata for purchase. |
| website/versioned_docs/version-v1/hardware/wiring-and-casing-guide/category.json | v1 snapshot category metadata for wiring/casing guide. |
| website/versioned_docs/version-v1/hardware/wiring-and-casing-guide/4-power-can.mdx | v1 snapshot of power & CAN wiring instructions. |
| website/versioned_docs/version-v1/hardware/wiring-and-casing-guide/3-chest.mdx | v1 snapshot of chest wiring & casing steps. |
| website/versioned_docs/version-v1/hardware/wiring-and-casing-guide/2-arm-casing.mdx | v1 snapshot of arm casing steps. |
| website/versioned_docs/version-v1/hardware/wiring-and-casing-guide/1-arm-wiring.mdx | v1 snapshot of arm wiring steps. |
| website/versioned_docs/version-v1/hardware/wiring-and-casing-guide/0-components.mdx | v1 snapshot of wiring/casing components list. |
| website/versioned_docs/version-v1/hardware/specifications/motor.mdx | v1 snapshot of motor specifications. |
| website/versioned_docs/version-v1/hardware/specifications/gripper.mdx | v1 snapshot of gripper specifications. |
| website/versioned_docs/version-v1/hardware/specifications/general.mdx | v1 snapshot of general hardware specifications. |
| website/versioned_docs/version-v1/hardware/specifications/category.json | v1 snapshot category metadata for hardware specifications. |
| website/versioned_docs/version-v1/hardware/bill-of-materials/procuring-components.mdx | v1 snapshot of procuring components guidance. |
| website/versioned_docs/version-v1/hardware/bill-of-materials/pedestal.mdx | v1 snapshot of pedestal BOM page. |
| website/versioned_docs/version-v1/hardware/bill-of-materials/gripper.mdx | v1 snapshot of gripper BOM page. |
| website/versioned_docs/version-v1/hardware/bill-of-materials/end-effector-leader.mdx | v1 snapshot of leader end-effector BOM page. |
| website/versioned_docs/version-v1/hardware/bill-of-materials/electrical.mdx | v1 snapshot of electrical BOM page. |
| website/versioned_docs/version-v1/hardware/bill-of-materials/arm-off-the-shelf.mdx | v1 snapshot of off-the-shelf arm BOM page. |
| website/versioned_docs/version-v1/hardware/bill-of-materials/arm-manufactured.mdx | v1 snapshot of manufactured arm BOM page. |
| website/versioned_docs/version-v1/hardware/bill-of-materials/category.json | v1 snapshot category metadata for hardware BOM. |
| website/versioned_docs/version-v1/hardware/assembly-guide/pedestal-assembly.mdx | v1 snapshot assembly guide: pedestal assembly. |
| website/versioned_docs/version-v1/hardware/assembly-guide/leader-end-effector-sub-assembly.mdx | v1 snapshot assembly guide: leader end-effector sub-assembly. |
| website/versioned_docs/version-v1/hardware/assembly-guide/j5-j6-j7-sub-assembly.mdx | v1 snapshot assembly guide: J5–J6–J7 sub-assembly. |
| website/versioned_docs/version-v1/hardware/assembly-guide/j4-j5-sub-assembly.mdx | v1 snapshot assembly guide: J4–J5 sub-assembly. |
| website/versioned_docs/version-v1/hardware/assembly-guide/j3-j4-sub-assembly.mdx | v1 snapshot assembly guide: J3–J4 sub-assembly. |
| website/versioned_docs/version-v1/hardware/assembly-guide/j2-j3-sub-assembly.mdx | v1 snapshot assembly guide: J2–J3 sub-assembly. |
| website/versioned_docs/version-v1/hardware/assembly-guide/j1-j2-sub-assembly.mdx | v1 snapshot assembly guide: J1–J2 sub-assembly. |
| website/versioned_docs/version-v1/hardware/assembly-guide/gripper-sub-assembly.mdx | v1 snapshot assembly guide: follower gripper sub-assembly. |
| website/versioned_docs/version-v1/hardware/assembly-guide/find-cad-files.mdx | v1 snapshot assembly guide: locating CAD files. |
| website/versioned_docs/version-v1/hardware/assembly-guide/final-assembly.mdx | v1 snapshot assembly guide: final assembly steps. |
| website/versioned_docs/version-v1/hardware/assembly-guide/category.json | v1 snapshot category metadata for hardware assembly guide. |
| website/versioned_docs/version-v1/hardware/category.json | v1 snapshot category metadata for hardware. |
| website/versioned_docs/version-v1/getting-started/safety-guide.mdx | v1 snapshot safety guide. |
| website/versioned_docs/version-v1/getting-started/project-overview.mdx | v1 snapshot project overview page. |
| website/versioned_docs/version-v1/getting-started/index.mdx | v1 snapshot docs homepage (“Discover OpenArm”). |
| website/versioned_docs/version-v1/getting-started/contribute.md | v1 snapshot contribution guide. |
| website/versioned_docs/version-v1/getting-started/category.json | v1 snapshot category metadata for getting started. |
| website/versioned_docs/version-v1/faq/index.md | v1 snapshot FAQ index. |
| website/versioned_docs/version-v1/faq/category.json | v1 snapshot category metadata for FAQ. |
| website/docusaurus.config.ts | Enables version switching and sets v1 as default while exposing v2 as preview; adds version dropdown to navbar. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | **Fo** | Friction offset (bias correction) | | ||
|
|
||
|
|
||
| ### Friction compasation Model |
There was a problem hiding this comment.
Typo in heading: “compasation” should be “compensation”.
| cd openarm_teleop | ||
| ``` | ||
|
|
||
| ### 2. Install Dependancy |
There was a problem hiding this comment.
Spelling: “Dependancy” should be “Dependency”.
|
|
||
| ## Overview | ||
|
|
||
| We now need to complete the motor setup sprocess. This involves three key tasks: |
There was a problem hiding this comment.
Typo: “sprocess” should be “process”.
| <BlockImage src="software/setup/hardware-setup-120r-termination.jpg" alt="120R termination" width="75%" /> | ||
| ::: | ||
|
|
||
| ### Reccomended Currents: |
There was a problem hiding this comment.
Spelling: “Reccomended” should be “Recommended”.
Comment on lines
+40
to
+46
| * **Opening a Drawer** | ||
|
|
||
| <BlockVideo src="simulation/isaac-lab/opening-drawer.mp4" width="65%"/> | ||
|
|
||
| * **Opening a Drawer** | ||
|
|
||
| <BlockVideo src="simulation/isaac-lab/openarm-bi-reach-demo.mp4" width="65%"/> |
There was a problem hiding this comment.
The “Demo Videos” list repeats “Opening a Drawer” twice, but the second video source is openarm-bi-reach-demo.mp4. Please rename the second bullet to match the actual demo (or update the video link if it’s intended to be another drawer demo).
Comment on lines
+63
to
+66
| If the CAN interfaces are omitted, the script uses the following defaults: | ||
|
|
||
| - For `right_arm`: leader = `can0`, follower = `can1` | ||
| - For `left_arm`: leader = `can2`, follower = `can3` |
There was a problem hiding this comment.
The documented default CAN interface mapping contradicts both the example commands above (can0/can2, can1/can3) and the earlier “Arguments” section. Please correct the stated defaults so they match the script’s actual defaults (likely right_arm: can0+can2, left_arm: can1+can3).
Contributor
Author
|
In v2, an alert shows at the top. v1
v2
|
Contributor
Author
|
I will fix the issues noted by Copilot in a separate PR. |
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.
We're getting ready to release v2 soon.
npm run docusaurus docs:version v1was run to apply versioning.Everything except
docusaurus.config.tswas automatically generated.The only manual change was to
docusaurus.config.ts.In
docusaurus.config.ts, version switching is configured, and v1 is set as the default documentation until everything is ready.