Skip to content

Commit 273b12d

Browse files
Seagull-YSeagull-Y
authored
Merge pull request #33 from i2rt-robotics/docs/add-product-images-and-videos
docs: add product images, videos, and fix navigation links
2 parents d36027f + 22f1dbc commit 273b12d

78 files changed

Lines changed: 7697 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.claude/launch.json‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"version": "0.0.1",
3+
"configurations": [
4+
{
5+
"name": "VitePress Dev",
6+
"runtimeExecutable": "/bin/bash",
7+
"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"],
8+
"port": 5173
9+
},
10+
{
11+
"name": "VitePress Preview",
12+
"runtimeExecutable": "/bin/bash",
13+
"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"],
14+
"port": 4173
15+
}
16+
]
17+
}

‎docs/.vitepress/config.mjs‎

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
import { defineConfig } from 'vitepress'
2+
3+
const base = process.env.DEPLOY_TARGET === 'cloudflare' ? '/' : '/JH_i2rt/'
4+
5+
export default defineConfig({
6+
title: 'I2RT Robotics',
7+
description: 'Open robotics platform for research and embodied AI — YAM arms, Flow Base, and more.',
8+
base,
9+
appearance: true,
10+
11+
head: [
12+
['link', { rel: 'preconnect', href: 'https://fonts.googleapis.com' }],
13+
['link', { rel: 'preconnect', href: 'https://fonts.gstatic.com', crossorigin: '' }],
14+
['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' }],
15+
['meta', { name: 'theme-color', content: '#855832' }],
16+
['meta', { property: 'og:type', content: 'website' }],
17+
['meta', { property: 'og:title', content: 'I2RT Robotics Docs' }],
18+
['meta', { property: 'og:description', content: 'Documentation for the YAM arm family, Flow Base, and Linear Bot.' }],
19+
],
20+
21+
themeConfig: {
22+
siteTitle: 'I2RT Docs',
23+
24+
nav: [
25+
{ text: 'Products', link: '/products/' },
26+
{ text: 'Get Started', link: '/getting-started/installation' },
27+
{ text: 'SDK', link: '/sdk/' },
28+
{ text: 'Examples', link: '/examples/' },
29+
{ text: 'Releases', link: '/releases/v1.0' },
30+
{ text: 'i2rt.com', link: 'https://i2rt.com', target: '_blank' },
31+
],
32+
33+
sidebar: {
34+
'/products/': [
35+
{
36+
text: 'Product Family',
37+
items: [
38+
{ text: 'Overview', link: '/products/' },
39+
],
40+
},
41+
{
42+
text: 'YAM Series',
43+
collapsed: false,
44+
items: [
45+
{ text: 'YAM Series Overview', link: '/products/yam' },
46+
{ text: 'YAM Arm', link: '/products/yam-arm' },
47+
{ text: 'YAM Leader Arm', link: '/products/yam-leader' },
48+
{ text: 'YAM Cell', link: '/products/yam-cell' },
49+
{ text: 'YAM Box', link: '/products/yam-box' },
50+
],
51+
},
52+
{
53+
text: 'Mobile',
54+
items: [
55+
{ text: 'Flow Base', link: '/products/flow-base' },
56+
{ text: 'Linear Bot', link: '/products/linear-bot' },
57+
],
58+
},
59+
{
60+
text: 'Motors',
61+
items: [
62+
{ text: 'Rovomotor ↗', link: 'https://rovomotor.com', target: '_blank' },
63+
],
64+
},
65+
],
66+
'/getting-started/': [
67+
{
68+
text: 'Getting Started',
69+
items: [
70+
{ text: 'Installation', link: '/getting-started/installation' },
71+
{ text: 'Hardware Setup', link: '/getting-started/hardware-setup' },
72+
{ text: 'Quick Start', link: '/getting-started/quick-start' },
73+
],
74+
},
75+
],
76+
'/sdk/': [
77+
{
78+
text: 'SDK Reference',
79+
items: [
80+
{ text: 'Overview', link: '/sdk/' },
81+
{ text: 'YAM Arm API', link: '/sdk/yam-arm' },
82+
{ text: 'Flow Base API', link: '/sdk/flow-base' },
83+
{ text: 'Grippers', link: '/sdk/grippers' },
84+
],
85+
},
86+
],
87+
'/examples/': [
88+
{
89+
text: 'Examples',
90+
items: [
91+
{ text: 'Overview', link: '/examples/' },
92+
{ text: 'Bimanual Teleoperation', link: '/examples/bimanual-teleoperation' },
93+
{ text: 'Record & Replay', link: '/examples/record-replay' },
94+
{ text: 'Motor Control', link: '/examples/motor-control' },
95+
{ text: 'MuJoCo Control', link: '/examples/control-with-mujoco' },
96+
],
97+
},
98+
],
99+
'/releases/': [
100+
{
101+
text: 'Release Notes',
102+
items: [
103+
{ text: 'v1.0', link: '/releases/v1.0' },
104+
],
105+
},
106+
],
107+
'/support/': [
108+
{
109+
text: 'Support',
110+
items: [
111+
{ text: 'Troubleshooting', link: '/support/troubleshooting' },
112+
],
113+
},
114+
],
115+
},
116+
117+
socialLinks: [
118+
{ icon: 'github', link: 'https://github.com/i2rt-robotics/i2rt' },
119+
{
120+
icon: {
121+
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>',
122+
},
123+
link: 'https://discord.gg/i2rt',
124+
},
125+
],
126+
127+
footer: {
128+
message: 'Released under the MIT License.',
129+
copyright: 'Copyright © 2024 I2RT Robotics, LLC — Fremont, CA',
130+
},
131+
132+
search: { provider: 'local' },
133+
134+
editLink: {
135+
pattern: 'https://github.com/i2rt-robotics/i2rt/edit/main/docs/:path',
136+
text: 'Edit this page on GitHub',
137+
},
138+
},
139+
})

‎docs/.vitepress/theme/components/MediaPlaceholder.vue‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<template>
2+
<div :class="['media-placeholder', type === 'video' ? 'video-placeholder' : 'photo-placeholder']">
3+
<div class="placeholder-icon">{{ type === 'video' ? '🎬' : '📷' }}</div>
4+
<div class="placeholder-label">{{ type === 'video' ? 'Video' : 'Photo' }} — Coming Soon</div>
5+
<div class="placeholder-desc">{{ description }}</div>
6+
</div>
7+
</template>
8+
9+
<script setup>
10+
defineProps({
11+
type: { type: String, default: 'video' }, // 'video' | 'photo'
12+
description: { type: String, default: 'Media asset placeholder — will be filmed/photographed and added here.' },
13+
})
14+
</script>

0 commit comments

Comments
 (0)