v2: rename sidebar sections by abetomo · Pull Request #460 · enactic/openarm

abetomo · 2026-04-20T09:26:21Z

Since we're changing the existing sidebars section names in 2.0, we'll rename them.

Getting Started -> Overview
Hardware -> Manufacturing guide
Software -> API reference

Because Docusaurus does not allow setting separate sidebars for each version, we need to use a common set of labels for both 1.0 and 2.0.

https://docusaurus.io/docs/versioning

github-actions · 2026-04-20T09:26:30Z

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.

abetomo · 2026-04-20T09:28:46Z

    }
  ],
-  "gettingStartedSidebar": [
+  "overviewSidebar": [


We need to use the same sidebar ID for both 1.0 and 2.0.
Although it doesn't match the directory name in 1.0, we've matched it to the sidebar ID in 2.0.

kou · 2026-04-20T09:35:18Z

        {
          type: 'docSidebar',
-          sidebarId: 'hardwareSidebar',
+          sidebarId: 'manufacturingGuideSidebar',


Can we remove Guide?

kou · 2026-04-20T09:35:38Z

+          sidebarId: 'overviewSidebar',
          position: 'left',
-          label: 'Getting started',
+          label: 'Getting started', // todo: Rename when v2 is ready.


We can rename this now because the current content is already "overview".

Copilot

Pull request overview

Updates the Docusaurus documentation structure to support renamed sidebar sections for the 2.0 docs while keeping 1.0 and 2.0 on a shared sidebar-id set (required by Docusaurus versioning constraints).

Changes:

Renames sidebar IDs across current and versioned sidebars (e.g., gettingStartedSidebar → overviewSidebar).
Updates the navbar sidebar bindings to use the renamed sidebar IDs.
Adds new/duplicated doc content under new top-level folders (overview/, manufacturing-guide/, api-reference/) for the 2.0 preview.

Reviewed changes

Copilot reviewed 3 out of 57 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
website/versioned_sidebars/version-1.0-sidebars.json	Renames v1.0 sidebar IDs to the new common IDs while still pointing at v1.0 doc dirs.
website/sidebars.ts	Renames current-version sidebar IDs and points them at new doc directories.
website/docusaurus.config.ts	Updates navbar items to reference the new sidebar IDs.
website/docs/overview/safety-guide.mdx	Adds overview content page.
website/docs/overview/project-overview.mdx	Adds overview content page.
website/docs/overview/index.mdx	Adds overview landing page (root slug).
website/docs/overview/contribute.md	Adds overview contribution page.
website/docs/overview/category.json	Adds overview category metadata.
website/docs/manufacturing-guide/wiring-and-casing-guide/category.json	Adds manufacturing-guide subcategory metadata.
website/docs/manufacturing-guide/wiring-and-casing-guide/4-power-can.mdx	Adds wiring/casing guide page.
website/docs/manufacturing-guide/wiring-and-casing-guide/3-chest.mdx	Adds wiring/casing guide page.
website/docs/manufacturing-guide/wiring-and-casing-guide/2-arm-casing.mdx	Adds wiring/casing guide page.
website/docs/manufacturing-guide/wiring-and-casing-guide/1-arm-wiring.mdx	Adds wiring/casing guide page.
website/docs/manufacturing-guide/wiring-and-casing-guide/0-components.mdx	Adds wiring/casing components page.
website/docs/manufacturing-guide/specifications/motor.mdx	Adds motor specification page.
website/docs/manufacturing-guide/specifications/gripper.mdx	Adds gripper specification page.
website/docs/manufacturing-guide/specifications/general.mdx	Adds general specification page (with hardware slug).
website/docs/manufacturing-guide/specifications/category.json	Adds specifications subcategory metadata.
website/docs/manufacturing-guide/bill-of-materials/procuring-components.mdx	Adds BOM procurement page.
website/docs/manufacturing-guide/bill-of-materials/pedestal.mdx	Adds BOM pedestal page.
website/docs/manufacturing-guide/bill-of-materials/gripper.mdx	Adds BOM gripper page.
website/docs/manufacturing-guide/bill-of-materials/end-effector-leader.mdx	Adds BOM leader end-effector page.
website/docs/manufacturing-guide/bill-of-materials/electrical.mdx	Adds BOM electrical page.
website/docs/manufacturing-guide/bill-of-materials/arm-off-the-shelf.mdx	Adds BOM off-the-shelf arm page.
website/docs/manufacturing-guide/bill-of-materials/arm-manufactured.mdx	Adds BOM manufactured arm page.
website/docs/manufacturing-guide/bill-of-materials/category.json	Adds BOM subcategory metadata.
website/docs/manufacturing-guide/assembly-guide/pedestal-assembly.mdx	Adds assembly guide page.
website/docs/manufacturing-guide/assembly-guide/leader-end-effector-sub-assembly.mdx	Adds assembly guide page.
website/docs/manufacturing-guide/assembly-guide/j5-j6-j7-sub-assembly.mdx	Adds assembly guide page.
website/docs/manufacturing-guide/assembly-guide/j4-j5-sub-assembly.mdx	Adds assembly guide page.
website/docs/manufacturing-guide/assembly-guide/j3-j4-sub-assembly.mdx	Adds assembly guide page.
website/docs/manufacturing-guide/assembly-guide/j2-j3-sub-assembly.mdx	Adds assembly guide page.
website/docs/manufacturing-guide/assembly-guide/j1-j2-sub-assembly.mdx	Adds assembly guide page.
website/docs/manufacturing-guide/assembly-guide/gripper-sub-assembly.mdx	Adds assembly guide page.
website/docs/manufacturing-guide/assembly-guide/find-cad-files.mdx	Adds assembly guide page.
website/docs/manufacturing-guide/assembly-guide/final-assembly.mdx	Adds assembly guide page.
website/docs/manufacturing-guide/assembly-guide/category.json	Adds assembly-guide subcategory metadata.
website/docs/manufacturing-guide/category.json	Adds manufacturing-guide category metadata.
website/docs/api-reference/ubuntu/index.mdx	Adds Ubuntu install guide page.
website/docs/api-reference/ubuntu/dual-boot.mdx	Adds Ubuntu dual-boot guide page.
website/docs/api-reference/ubuntu/docker.mdx	Adds Docker-based Ubuntu guide page.
website/docs/api-reference/ubuntu/category.json	Adds Ubuntu subcategory metadata.
website/docs/api-reference/setup/index.md	Adds setup landing page.
website/docs/api-reference/setup/category.json	Adds setup subcategory metadata.
website/docs/api-reference/setup/5-run-demo.mdx	Adds setup step page.
website/docs/api-reference/setup/4-motor-config.mdx	Adds setup step page.
website/docs/api-reference/setup/3-configure-test.mdx	Adds setup step page.
website/docs/api-reference/setup/2-can-setup.mdx	Adds setup step page.
website/docs/api-reference/setup/1-motor-id.mdx	Adds setup step page.
website/docs/api-reference/ros2/install.mdx	Adds ROS 2 install page.
website/docs/api-reference/ros2/control.mdx	Adds ROS 2 control page.
website/docs/api-reference/ros2/category.json	Adds ROS 2 subcategory metadata.
website/docs/api-reference/index.md	Adds API reference landing page.
website/docs/api-reference/description.mdx	Adds robot description docs page.
website/docs/api-reference/controls.md	Adds controls placeholder page.
website/docs/api-reference/can.mdx	Adds CAN library docs page.
website/docs/api-reference/category.json	Adds API reference category metadata.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-20T09:36:05Z

          type: 'docSidebar',
-          sidebarId: 'gettingStartedSidebar',
+          sidebarId: 'overviewSidebar',
          position: 'left',
-          label: 'Getting started',
+          label: 'Getting started', // todo: Rename when v2 is ready.
        },
        {
          type: 'docSidebar',
-          sidebarId: 'hardwareSidebar',
+          sidebarId: 'manufacturingGuideSidebar',
          position: 'left',
-          label: 'Hardware',
+          label: 'Hardware', // todo: Rename when v2 is ready.
        },
        {
          type: 'docSidebar',
-          sidebarId: 'softwareSidebar',
+          sidebarId: 'apiReferenceSidebar',
          position: 'left',
-          label: 'Software',
+          label: 'Software', // todo: Rename when v2 is ready.
        },


PR description says the sidebar section names are being renamed (Getting Started→Overview, Hardware→Manufacturing guide, Software→API reference), but the navbar labels are still the old names with TODOs. If the intent is to apply the rename now, these label values should be updated to the new names (or the PR description/title should be adjusted to match the current behavior).

Since we're changing the existing sidebars section names in 2.0, we'll rename them. * Getting Started -> Overview * Hardware -> Manufacturing guide * Software -> API reference Because Docusaurus does not allow setting separate sidebars for each version, we need to use a common set of labels for both 1.0 and 2.0. https://docusaurus.io/docs/versioning

Copilot AI review requested due to automatic review settings April 20, 2026 09:26

Copilot started reviewing on behalf of abetomo April 20, 2026 09:26 View session

abetomo commented Apr 20, 2026

View reviewed changes

kou reviewed Apr 20, 2026

View reviewed changes

Copilot AI reviewed Apr 20, 2026

View reviewed changes

abetomo force-pushed the v2-rename-category branch from cd3fa1a to e9cf961 Compare April 20, 2026 09:42

kou merged commit 5497723 into enactic:main Apr 28, 2026
3 checks passed

abetomo deleted the v2-rename-category branch April 28, 2026 03:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

v2: rename sidebar sections#460

v2: rename sidebar sections#460
kou merged 1 commit into
enactic:mainfrom
abetomo:v2-rename-category

abetomo commented Apr 20, 2026

Uh oh!

github-actions Bot commented Apr 20, 2026

Uh oh!

abetomo Apr 20, 2026

Uh oh!

kou Apr 20, 2026

Uh oh!

kou Apr 20, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

abetomo commented Apr 20, 2026

Uh oh!

github-actions Bot commented Apr 20, 2026

Uh oh!

abetomo Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

kou Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

kou Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants