docs: restructure navigation around products and per-product onboarding#45
Closed
Seagull-Y wants to merge 2 commits into
Closed
docs: restructure navigation around products and per-product onboarding#45Seagull-Y wants to merge 2 commits into
Seagull-Y wants to merge 2 commits into
Conversation
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>
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. |
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.
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
After
What changed
New files (13)
docs/getting-started/sw-setup.mddocs/getting-started/hardware/{yam, yam-cell, yam-box, flow-base, linear-bot, motors}.mddocs/getting-started/demos/{yam, yam-cell, yam-box, flow-base, linear-bot, motors}.mdExpanded product pages
products/yam.md— now ~800 lines: specs + photos + full API reference + gravity-comp guide + MuJoCo & Viser control + record-replayproducts/yam-cell.md— added bimanual teleop walkthrough + minimum_gello referenceproducts/flow-base.md— added fullFlowBaseClientSDK APIproducts/motors.md— added single-motor PD example + config toolsDeleted (no longer needed)
docs/sdk/→ merged into product pagesdocs/examples/→ merged into product pagesdocs/guides/→ merged into product pagesdocs/releases/→ use GitHub Releasesdocs/support/troubleshooting.md→ not in new navdocs/getting-started/{installation, hardware-setup, quick-start}.md→ replaced by sw-setup + per-product pagesConfig
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-setupand/getting-started/demos/yamInternal 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:buildclean (no warnings, no broken links)#api-reference,#gravity-friction-compensation,#bimanual-teleoperation, etc.) — 1 match each in deployed HTMLlocalhost:4173/JH_i2rt/Test plan
Get Started → SW Setup → Hardware → Demoflow for each product🤖 Generated with Claude Code