Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
a0fa254
Update README.md
i2rt-software Sep 6, 2025
13f2206
Merge branch 'main' of github.com:i2rt-robotics/i2rt
Sep 6, 2025
3348c95
resolve few small typos in readmes
johnnewsom Sep 6, 2025
0e470c0
Merge pull request #11 from parametricpbc/johnnewsom/readme-stuff
i2rt-software Sep 13, 2025
98d177b
teaching_handle set the weight to 0.258
kamefox Oct 29, 2025
4fb67a0
dump
Jan 22, 2026
ea4b586
update flow doc
Jan 23, 2026
25e78c2
Merge pull request #22 from i2rt-robotics/dev/linearbot_and_bigyam
i2rt-software Feb 17, 2026
feb49ea
dump
Mar 3, 2026
a2eb7be
change doc
Mar 3, 2026
13ec799
feat: add interactive 3D robot viewer, fix set_zero to reset all motors
Mar 14, 2026
e8d5e6a
fix: use normalized 0-1 range for gripper slider in viser control
Mar 14, 2026
2521114
Merge pull request #26 from i2rt-robotics/dev/pre_release_3_3
i2rt-software Mar 14, 2026
5d3f140
feat: expose ee_mass as CLI argument in minimum_gello.py
Mar 14, 2026
ac23423
refactor: move minimum_gello.py to examples/minimum_gello/ with README
Mar 14, 2026
4b751f4
docs: add product images, videos, and fix navigation links
Seagull-Y Apr 15, 2026
5e8e143
docs: transcode videos to H.264 mp4 and update references
Seagull-Y Apr 15, 2026
9269b14
docs: convert all product images from PNG/JPG to WebP
Seagull-Y Apr 15, 2026
c095597
docs: add GF series motor pages and Motors sidebar category
Seagull-Y Apr 15, 2026
b573587
docs: add dimension drawings to GF series motor pages
Seagull-Y Apr 15, 2026
88fd563
docs: replace Motors sidebar section with Rovomotor external link
Seagull-Y Apr 15, 2026
91ea808
docs: remove redundant captions below embedded images and videos
Seagull-Y Apr 15, 2026
8627906
docs: remove figcaption text from product image galleries
Seagull-Y Apr 15, 2026
9e6c128
docs: update color scheme, SDK docs, and product pages
Seagull-Y Apr 27, 2026
22f1dbc
chore: merge main into docs branch, resolve conflicts
Seagull-Y Apr 27, 2026
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
17 changes: 17 additions & 0 deletions .claude/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"version": "0.0.1",
"configurations": [
{
"name": "VitePress Dev",
"runtimeExecutable": "/bin/bash",
"runtimeArgs": ["-c", "export PATH=/opt/homebrew/bin:/usr/local/bin:$PATH && cd '/Users/zhongkeyi/Library/Mobile Documents/com~apple~CloudDocs/Work/i2rt/doc/web' && npm run docs:dev"],
"port": 5173
},
{
"name": "VitePress Preview",
"runtimeExecutable": "/bin/bash",
"runtimeArgs": ["-c", "export PATH=/opt/homebrew/bin:/usr/local/bin:$PATH && cd '/Users/zhongkeyi/Library/Mobile Documents/com~apple~CloudDocs/Work/i2rt/doc/web' && npm run docs:preview"],
"port": 4173
}
]
}
139 changes: 139 additions & 0 deletions docs/.vitepress/config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
import { defineConfig } from 'vitepress'

const base = process.env.DEPLOY_TARGET === 'cloudflare' ? '/' : '/JH_i2rt/'

export default defineConfig({
title: 'I2RT Robotics',
description: 'Open robotics platform for research and embodied AI — YAM arms, Flow Base, and more.',
base,
appearance: true,

head: [
['link', { rel: 'preconnect', href: 'https://fonts.googleapis.com' }],
['link', { rel: 'preconnect', href: 'https://fonts.gstatic.com', crossorigin: '' }],
['link', { href: 'https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:wght@400;600&family=Inter:wght@300;400;500;600;700&display=swap', rel: 'stylesheet' }],
['meta', { name: 'theme-color', content: '#855832' }],
['meta', { property: 'og:type', content: 'website' }],
['meta', { property: 'og:title', content: 'I2RT Robotics Docs' }],
['meta', { property: 'og:description', content: 'Documentation for the YAM arm family, Flow Base, and Linear Bot.' }],
],

themeConfig: {
siteTitle: 'I2RT Docs',

nav: [
{ text: 'Products', link: '/products/' },
{ text: 'Get Started', link: '/getting-started/installation' },
{ text: 'SDK', link: '/sdk/' },
{ text: 'Examples', link: '/examples/' },
{ text: 'Releases', link: '/releases/v1.0' },
{ text: 'i2rt.com', link: 'https://i2rt.com', target: '_blank' },
],

sidebar: {
'/products/': [
{
text: 'Product Family',
items: [
{ text: 'Overview', link: '/products/' },
],
},
{
text: 'YAM Series',
collapsed: false,
items: [
{ text: 'YAM Series Overview', link: '/products/yam' },
{ text: 'YAM Arm', link: '/products/yam-arm' },
{ text: 'YAM Leader Arm', link: '/products/yam-leader' },
{ text: 'YAM Cell', link: '/products/yam-cell' },
{ text: 'YAM Box', link: '/products/yam-box' },
],
},
{
text: 'Mobile',
items: [
{ text: 'Flow Base', link: '/products/flow-base' },
{ text: 'Linear Bot', link: '/products/linear-bot' },
],
},
{
text: 'Motors',
items: [
{ text: 'Rovomotor ↗', link: 'https://rovomotor.com', target: '_blank' },
],
},
],
'/getting-started/': [
{
text: 'Getting Started',
items: [
{ text: 'Installation', link: '/getting-started/installation' },
{ text: 'Hardware Setup', link: '/getting-started/hardware-setup' },
{ text: 'Quick Start', link: '/getting-started/quick-start' },
],
},
],
'/sdk/': [
{
text: 'SDK Reference',
items: [
{ text: 'Overview', link: '/sdk/' },
{ text: 'YAM Arm API', link: '/sdk/yam-arm' },
{ text: 'Flow Base API', link: '/sdk/flow-base' },
{ text: 'Grippers', link: '/sdk/grippers' },
],
},
],
'/examples/': [
{
text: 'Examples',
items: [
{ text: 'Overview', link: '/examples/' },
{ text: 'Bimanual Teleoperation', link: '/examples/bimanual-teleoperation' },
{ text: 'Record & Replay', link: '/examples/record-replay' },
{ text: 'Motor Control', link: '/examples/motor-control' },
{ text: 'MuJoCo Control', link: '/examples/control-with-mujoco' },
],
},
],
'/releases/': [
{
text: 'Release Notes',
items: [
{ text: 'v1.0', link: '/releases/v1.0' },
],
},
],
'/support/': [
{
text: 'Support',
items: [
{ text: 'Troubleshooting', link: '/support/troubleshooting' },
],
},
],
},

socialLinks: [
{ icon: 'github', link: 'https://github.com/i2rt-robotics/i2rt' },
{
icon: {
svg: '<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M20.317 4.37a19.791 19.791 0 0 0-4.885-1.515.074.074 0 0 0-.079.037c-.21.375-.444.864-.608 1.25a18.27 18.27 0 0 0-5.487 0 12.64 12.64 0 0 0-.617-1.25.077.077 0 0 0-.079-.037A19.736 19.736 0 0 0 3.677 4.37a.07.07 0 0 0-.032.027C.533 9.046-.32 13.58.099 18.057.11 18.101.127 18.143.158 18.17a19.9 19.9 0 0 0 5.993 3.03.078.078 0 0 0 .084-.028 14.09 14.09 0 0 0 1.226-1.994.076.076 0 0 0-.041-.106 13.107 13.107 0 0 1-1.872-.892.077.077 0 0 1-.008-.128 10.2 10.2 0 0 0 .372-.292.074.074 0 0 1 .077-.01c3.928 1.793 8.18 1.793 12.062 0a.074.074 0 0 1 .078.01c.12.098.246.198.373.292a.077.077 0 0 1-.006.127 12.299 12.299 0 0 1-1.873.892.077.077 0 0 0-.041.107c.36.698.772 1.362 1.225 1.993a.076.076 0 0 0 .084.028 19.839 19.839 0 0 0 6.002-3.03.077.077 0 0 0 .032-.054c.5-5.177-.838-9.674-3.549-13.66a.061.061 0 0 0-.031-.03z"/></svg>',
},
link: 'https://discord.gg/i2rt',
},
],

footer: {
message: 'Released under the MIT License.',
copyright: 'Copyright © 2024 I2RT Robotics, LLC — Fremont, CA',
},

search: { provider: 'local' },

editLink: {
pattern: 'https://github.com/i2rt-robotics/i2rt/edit/main/docs/:path',
text: 'Edit this page on GitHub',
},
},
})
14 changes: 14 additions & 0 deletions docs/.vitepress/theme/components/MediaPlaceholder.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<template>
<div :class="['media-placeholder', type === 'video' ? 'video-placeholder' : 'photo-placeholder']">
<div class="placeholder-icon">{{ type === 'video' ? '🎬' : '📷' }}</div>
<div class="placeholder-label">{{ type === 'video' ? 'Video' : 'Photo' }} — Coming Soon</div>
<div class="placeholder-desc">{{ description }}</div>
</div>
</template>

<script setup>
defineProps({
type: { type: String, default: 'video' }, // 'video' | 'photo'
description: { type: String, default: 'Media asset placeholder — will be filmed/photographed and added here.' },
})
</script>
Loading
Loading