Skip to content

docs: restructure navigation around products and per-product onboarding#45

Closed
Seagull-Y wants to merge 2 commits into
mainfrom
docs/restructure-nav
Closed

docs: restructure navigation around products and per-product onboarding#45
Seagull-Y wants to merge 2 commits into
mainfrom
docs/restructure-nav

Conversation

@Seagull-Y
Copy link
Copy Markdown
Contributor

Summary

Restructures the documentation site to align with how users actually consume it: pick a product → follow setup → run a demo → dive into the full product page. Removes the parallel SDK / Examples / Guides hierarchy and merges those into the relevant product pages.

Before

Top nav: Products | Get Started | SDK | Examples | Guides | Releases | i2rt.com

docs/
├── getting-started/   installation, hardware-setup, quick-start  (3 monolithic pages)
├── products/          (product pages with limited content)
├── sdk/               yam-arm, flow-base, grippers
├── guides/            gravity-compensation
├── examples/          bimanual, record-replay, motor-control, mujoco, viser, gello
├── releases/          v1.0, v1.1, v1.1.1
└── support/           troubleshooting

After

Top nav: Get Started | Products | i2rt.com

docs/
├── getting-started/
│   ├── sw-setup                    one-time CAN + Python env
│   ├── hardware/
│   │   └── {yam, yam-cell, yam-box, flow-base, linear-bot, motors}
│   └── demos/
│       └── {yam, yam-cell, yam-box, flow-base, linear-bot, motors}
└── products/
    ├── yam.md          ← merged: SDK API + grippers + gravity-comp guide
    │                              + MuJoCo + Viser + record-replay
    ├── yam-cell.md     ← merged: bimanual teleop + minimum_gello
    ├── flow-base.md    ← merged: full FlowBaseClient SDK API
    ├── motors.md       ← merged: single-motor PD control example
    └── yam-arm, yam-leader, yam-box, linear-bot, motor-gf*

What changed

New files (13)

  • docs/getting-started/sw-setup.md
  • docs/getting-started/hardware/{yam, yam-cell, yam-box, flow-base, linear-bot, motors}.md
  • docs/getting-started/demos/{yam, yam-cell, yam-box, flow-base, linear-bot, motors}.md

Expanded product pages

  • products/yam.md — now ~800 lines: specs + photos + full API reference + gravity-comp guide + MuJoCo & Viser control + record-replay
  • products/yam-cell.md — added bimanual teleop walkthrough + minimum_gello reference
  • products/flow-base.md — added full FlowBaseClient SDK API
  • products/motors.md — added single-motor PD example + config tools

Deleted (no longer needed)

  • docs/sdk/ → merged into product pages
  • docs/examples/ → merged into product pages
  • docs/guides/ → merged into product pages
  • docs/releases/ → use GitHub Releases
  • docs/support/troubleshooting.md → not in new nav
  • docs/getting-started/{installation, hardware-setup, quick-start}.md → replaced by sw-setup + per-product pages

Config

  • docs/.vitepress/config.mjs — nav reduced to 3 items; sidebar collapsed to two top-level groups (Get Started, Products)
  • docs/index.md — CTAs point to /getting-started/sw-setup and /getting-started/demos/yam

Internal links

All /sdk/, /examples/, /guides/, /releases/, /support/, /getting-started/{installation, hardware-setup, quick-start} references rewritten to new paths or in-page anchors.

Verification

  • npm run docs:build clean (no warnings, no broken links)
  • All in-page anchor targets verified (#api-reference, #gravity-friction-compensation, #bimanual-teleoperation, etc.) — 1 match each in deployed HTML
  • All 13 new pages render at expected routes
  • Local preview verified at localhost:4173/JH_i2rt/

Test plan

  • Click through Get Started → SW Setup → Hardware → Demo flow for each product
  • Open each product page and verify TOC navigation (right sidebar) works for the long ones (yam in particular)
  • Confirm top nav and side nav match the new structure
  • Check that no 404s appear when clicking around

🤖 Generated with Claude Code

Seagull-Y and others added 2 commits May 20, 2026 16:38
Simplify the top nav to three items (Get Started | Products | i2rt.com)
and reorganize content around products instead of a parallel SDK/Examples/
Guides hierarchy. Each product page is now one-page-to-bottom (specs,
photos, API, examples, advanced guides), and Get Started is a lean
hardware setup + first demo path per product.

## New structure

Get Started
├── SW Setup              (CAN + Python env, one-time)
├── Hardware Setup        (lean per-product checklists)
│   └── YAM, YAM Cell, YAM Box, Flow Base, Linear Bot, Motors
└── Quick Start Demos     (first runnable demo per product)
    └── YAM, YAM Cell, YAM Box, Flow Base, Linear Bot, Motors

Products
├── YAM Arm Series        (full SDK API ref, gravity-comp guide,
│                          MuJoCo/Viser interfaces, record-replay)
├── YAM Cell              (bimanual teleop, minimum_gello)
├── YAM Box, YAM Leader, YAM Arm
├── Flow Base             (full SDK API ref, linear rail)
├── Linear Bot
└── Motors                (PD control example + config tools)

## Removed

- docs/sdk/         → merged into products/{yam,flow-base,motors}.md
- docs/examples/    → merged into the relevant product page
- docs/guides/      → merged into products/yam.md
- docs/releases/    → use GitHub Releases instead
- docs/support/troubleshooting.md → not in new nav
- docs/getting-started/{installation,hardware-setup,quick-start}.md
                     → replaced by sw-setup.md + per-product hardware/demos pages

## Notes

- Homepage CTAs updated to /getting-started/sw-setup and /getting-started/demos/yam
- All internal links remapped to new locations or in-page anchors
- Build succeeds with no broken-link warnings; all anchor targets verified

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…nav with GitHub

Per user feedback, the per-product Get Started pages were a redundant layer
between SW Setup and the canonical product pages. Each product page now
contains everything for that product in one scrollable page: specs +
photos + hardware setup + quick-start demo + SDK API + examples.

## Changes

### Top nav (3 items, GitHub replaces Products)
Before:  Get Started | Products | i2rt.com
After:   Get Started | GitHub    | i2rt.com

### Sidebar
The Get Started and Products sections now share one unified sidebar:
SW Setup at the top, then each product as a single link to its full
one-page article.

### Product pages — added Hardware Setup + Quick Start Demo sections
- products/yam.md          + hardware checklist + sim/zero-grav/Python demo
- products/yam-cell.md     + 5-step 4-arm checklist + 4-terminal bimanual launch
- products/yam-box.md      + Quick Start Demo block (existing Assembly Guide
                              already covers hardware setup)
- products/flow-base.md    + 5-step Pi/joystick checklist + Python API demo
- products/linear-bot.md   + rail homing + arm mount checklist + 4D velocity demo
- products/motors.md       + standalone motor checklist + MIT-mode demo

### Deleted
- docs/getting-started/hardware/*.md  (6 redundant checklists)
- docs/getting-started/demos/*.md     (6 redundant demo pages)

### Internal links
All /getting-started/hardware/X and /getting-started/demos/X links
rewritten to /products/X#hardware-setup or /products/X#quick-start-demo
(yam-box uses #assembly-guide for the existing assembly walkthrough).

### Homepage
"Full Quick Start" CTA now points to /products/yam#quick-start-demo.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@Seagull-Y
Copy link
Copy Markdown
Contributor Author

Closing — the docs content has been migrated to the private repo i2rt-robotics/i2rt-docs (with all the changes in this PR plus more). The docs/ folder will be removed from this public repo in a follow-up PR.

@Seagull-Y Seagull-Y closed this May 22, 2026
@nu-jliu nu-jliu deleted the docs/restructure-nav branch May 26, 2026 11:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant