Skip to content

v2: rename sidebar sections #460

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kou merged 1 commit into from
Apr 28, 2026
Merged

v2: rename sidebar sections #460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 website/docs/software/_category_.json → website/docs/api-reference/_category_.json
View file
Open in desktop
File renamed without changes.
0 website/docs/software/can.mdx → website/docs/api-reference/can.mdx
View file
Open in desktop
File renamed without changes.
0 website/docs/software/controls.md → website/docs/api-reference/controls.md
View file
Open in desktop
File renamed without changes.
0 website/docs/software/description.mdx → website/docs/api-reference/description.mdx
View file
Open in desktop
File renamed without changes.
0 website/docs/software/index.md → website/docs/api-reference/index.md
View file
Open in desktop
File renamed without changes.
0 website/docs/software/ros2/_category_.json → ...e/docs/api-reference/ros2/_category_.json
View file
Open in desktop
File renamed without changes.
0 website/docs/software/ros2/control.mdx → website/docs/api-reference/ros2/control.mdx
View file
Open in desktop
File renamed without changes.
0 website/docs/software/ros2/install.mdx → website/docs/api-reference/ros2/install.mdx
View file
Open in desktop
File renamed without changes.
0 website/docs/software/setup/1-motor-id.mdx → ...e/docs/api-reference/setup/1-motor-id.mdx
View file
Open in desktop
File renamed without changes.
0 website/docs/software/setup/2-can-setup.mdx → .../docs/api-reference/setup/2-can-setup.mdx
View file
Open in desktop
File renamed without changes.
0 .../docs/software/setup/3-configure-test.mdx → .../api-reference/setup/3-configure-test.mdx
View file
Open in desktop
File renamed without changes.
0 ...te/docs/software/setup/4-motor-config.mdx → ...cs/api-reference/setup/4-motor-config.mdx
View file
Open in desktop
File renamed without changes.
0 website/docs/software/setup/5-run-demo.mdx → ...e/docs/api-reference/setup/5-run-demo.mdx
View file
Open in desktop
File renamed without changes.
0 website/docs/software/setup/_category_.json → .../docs/api-reference/setup/_category_.json
View file
Open in desktop
File renamed without changes.
0 website/docs/software/setup/index.md → website/docs/api-reference/setup/index.md
View file
Open in desktop
File renamed without changes.
0 website/docs/software/ubuntu/_category_.json → ...docs/api-reference/ubuntu/_category_.json
View file
Open in desktop
File renamed without changes.
0 website/docs/software/ubuntu/docker.mdx → website/docs/api-reference/ubuntu/docker.mdx
View file
Open in desktop
File renamed without changes.
0 website/docs/software/ubuntu/dual-boot.mdx → ...e/docs/api-reference/ubuntu/dual-boot.mdx
View file
Open in desktop
File renamed without changes.
0 website/docs/software/ubuntu/index.mdx → website/docs/api-reference/ubuntu/index.mdx
View file
Open in desktop
File renamed without changes.
0 website/docs/hardware/_category_.json → website/docs/manufacturing/_category_.json
View file
Open in desktop
File renamed without changes.
0 ...s/hardware/assembly-guide/_category_.json → ...ufacturing/assembly-guide/_category_.json
View file
Open in desktop
File renamed without changes.
0 ...ardware/assembly-guide/final-assembly.mdx → ...cturing/assembly-guide/final-assembly.mdx
View file
Open in desktop
File renamed without changes.
0 ...ardware/assembly-guide/find-cad-files.mdx → ...cturing/assembly-guide/find-cad-files.mdx
View file
Open in desktop
File renamed without changes.
0 ...e/assembly-guide/gripper-sub-assembly.mdx → ...g/assembly-guide/gripper-sub-assembly.mdx
View file
Open in desktop
File renamed without changes.
0 ...are/assembly-guide/j1-j2-sub-assembly.mdx → ...ing/assembly-guide/j1-j2-sub-assembly.mdx
View file
Open in desktop
File renamed without changes.
0 ...are/assembly-guide/j2-j3-sub-assembly.mdx → ...ing/assembly-guide/j2-j3-sub-assembly.mdx
View file
Open in desktop
File renamed without changes.
0 ...are/assembly-guide/j3-j4-sub-assembly.mdx → ...ing/assembly-guide/j3-j4-sub-assembly.mdx
View file
Open in desktop
File renamed without changes.
0 ...are/assembly-guide/j4-j5-sub-assembly.mdx → ...ing/assembly-guide/j4-j5-sub-assembly.mdx
View file
Open in desktop
File renamed without changes.
0 .../assembly-guide/j5-j6-j7-sub-assembly.mdx → .../assembly-guide/j5-j6-j7-sub-assembly.mdx
View file
Open in desktop
File renamed without changes.
0 ...uide/leader-end-effector-sub-assembly.mdx → ...uide/leader-end-effector-sub-assembly.mdx
View file
Open in desktop
File renamed without changes.
0 ...ware/assembly-guide/pedestal-assembly.mdx → ...ring/assembly-guide/pedestal-assembly.mdx
View file
Open in desktop
File renamed without changes.
0 ...ardware/bill-of-materials/_category_.json → ...cturing/bill-of-materials/_category_.json
View file
Open in desktop
File renamed without changes.
0 ...re/bill-of-materials/arm-manufactured.mdx → ...ng/bill-of-materials/arm-manufactured.mdx
View file
Open in desktop
File renamed without changes.
0 ...e/bill-of-materials/arm-off-the-shelf.mdx → ...g/bill-of-materials/arm-off-the-shelf.mdx
View file
Open in desktop
File renamed without changes.
0 ...hardware/bill-of-materials/electrical.mdx → ...acturing/bill-of-materials/electrical.mdx
View file
Open in desktop
File renamed without changes.
0 ...bill-of-materials/end-effector-leader.mdx → ...bill-of-materials/end-effector-leader.mdx
View file
Open in desktop
File renamed without changes.
0 ...cs/hardware/bill-of-materials/gripper.mdx → ...nufacturing/bill-of-materials/gripper.mdx
View file
Open in desktop
File renamed without changes.
0 ...s/hardware/bill-of-materials/pedestal.mdx → ...ufacturing/bill-of-materials/pedestal.mdx
View file
Open in desktop
File renamed without changes.
0 ...ill-of-materials/procuring-components.mdx → ...ill-of-materials/procuring-components.mdx
View file
Open in desktop
File renamed without changes.
0 ...s/hardware/specifications/_category_.json → ...ufacturing/specifications/_category_.json
View file
Open in desktop
File renamed without changes.
0 .../docs/hardware/specifications/general.mdx → .../manufacturing/specifications/general.mdx
View file
Open in desktop
File renamed without changes.
0 .../docs/hardware/specifications/gripper.mdx → .../manufacturing/specifications/gripper.mdx
View file
Open in desktop
File renamed without changes.
0 ...te/docs/hardware/specifications/motor.mdx → ...cs/manufacturing/specifications/motor.mdx
View file
Open in desktop
File renamed without changes.
0 .../wiring-and-casing-guide/0-components.mdx → .../wiring-and-casing-guide/0-components.mdx
View file
Open in desktop
File renamed without changes.
0 .../wiring-and-casing-guide/1-arm-wiring.mdx → .../wiring-and-casing-guide/1-arm-wiring.mdx
View file
Open in desktop
File renamed without changes.
0 .../wiring-and-casing-guide/2-arm-casing.mdx → .../wiring-and-casing-guide/2-arm-casing.mdx
View file
Open in desktop
File renamed without changes.
0 ...dware/wiring-and-casing-guide/3-chest.mdx → ...uring/wiring-and-casing-guide/3-chest.mdx
View file
Open in desktop
File renamed without changes.
0 ...e/wiring-and-casing-guide/4-power-can.mdx → ...g/wiring-and-casing-guide/4-power-can.mdx
View file
Open in desktop
File renamed without changes.
0 ...e/wiring-and-casing-guide/_category_.json → ...g/wiring-and-casing-guide/_category_.json
View file
Open in desktop
File renamed without changes.
0 website/docs/getting-started/_category_.json → website/docs/overview/_category_.json
View file
Open in desktop
File renamed without changes.
0 website/docs/getting-started/contribute.md → website/docs/overview/contribute.md
View file
Open in desktop
File renamed without changes.
0 website/docs/getting-started/index.mdx → website/docs/overview/index.mdx
View file
Open in desktop
File renamed without changes.
0 ...docs/getting-started/project-overview.mdx → website/docs/overview/project-overview.mdx
View file
Open in desktop
File renamed without changes.
0 ...ite/docs/getting-started/safety-guide.mdx → website/docs/overview/safety-guide.mdx
View file
Open in desktop
File renamed without changes.
12 changes: 6 additions & 6 deletions website/docusaurus.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,21 +117,21 @@ const config: Config = {
items: [
{
type: 'docSidebar',
sidebarId: 'gettingStartedSidebar',
sidebarId: 'overviewSidebar',
position: 'left',
label: 'Getting started',
label: 'Overview',
},
{
type: 'docSidebar',
sidebarId: 'hardwareSidebar',
sidebarId: 'manufacturingSidebar',
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.
},
Comment on lines 119 to 135
Copy link

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copilot uses AI. Check for mistakes.
{
type: 'docSidebar',
Expand Down
6 changes: 3 additions & 3 deletions website/sidebars.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ const sidebars: SidebarsConfig = {
// By default, Docusaurus generates a sidebar from the docs folder structure
topSidebar: [{type: 'autogenerated', dirName: '.'}],

gettingStartedSidebar: [{type: 'autogenerated', dirName: 'getting-started'}],
hardwareSidebar: [{type: 'autogenerated', dirName: 'hardware'}],
softwareSidebar: [{type: 'autogenerated', dirName: 'software'}],
overviewSidebar: [{type: 'autogenerated', dirName: 'overview'}],
manufacturingSidebar: [{type: 'autogenerated', dirName: 'manufacturing'}],
apiReferenceSidebar: [{type: 'autogenerated', dirName: 'api-reference'}],
teleopSidebar: [{type: 'autogenerated', dirName: 'teleop'}],
simulationSidebar: [{type: 'autogenerated', dirName: 'simulation'}],
purchaseSidebar: [{type: 'autogenerated', dirName: 'purchase'}],
Expand Down
6 changes: 3 additions & 3 deletions website/versioned_sidebars/version-1.0-sidebars.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@
"dirName": "."
}
],
"gettingStartedSidebar": [
"overviewSidebar": [
Copy link
Copy Markdown
Contributor Author

@abetomo abetomo Apr 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

{
"type": "autogenerated",
"dirName": "getting-started"
}
],
"hardwareSidebar": [
"manufacturingSidebar": [
{
"type": "autogenerated",
"dirName": "hardware"
}
],
"softwareSidebar": [
"apiReferenceSidebar": [
{
"type": "autogenerated",
"dirName": "software"
Expand Down