Skip to content

Commit 81a10ee

Browse files
Jiu-xiaoJiu-xiao
committed
docs(home): sync english homepage and agent prompt
1 parent c3b6951 commit 81a10ee

4 files changed

Lines changed: 384 additions & 196 deletions

File tree

‎i18n/en/code.json‎

Lines changed: 145 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,43 +3,163 @@
33
"message": "Home"
44
},
55
"homepage.description": {
6-
"message": "Documentation homepage for the XRobot project"
6+
"message": "Development documentation for XRobot and LibXR."
77
},
8-
"homepage.heroTitle": {
9-
"message": "Welcome to XRobot"
8+
"homepage.hero.title": {
9+
"message": "XRobot / LibXR"
1010
},
11-
"homepage.heroSubtitle": {
12-
"message": "A documentation and tutorial platform for robotics and embedded developers"
11+
"homepage.hero.lead": {
12+
"message": "A modular framework for robotics development, device interfaces, and engineering automation. XRobot covers package management, project layout, and code generation, while LibXR provides core semantics, driver abstractions, and XRUSB."
1313
},
14-
"homepage.getStarted": {
15-
"message": "Get Started"
14+
"homepage.hero.cta.read": {
15+
"message": "Start Reading"
1616
},
17-
"homepage.feature1.title": {
18-
"message": "Documentation Support"
17+
"homepage.hero.cta.concept": {
18+
"message": "Read the Design Concepts"
1919
},
20-
"homepage.feature1.content": {
21-
"message": "Organize various project contents modularly, from setup, getting started to advanced usage, easy to maintain and consult."
20+
"homepage.hero.cta.xrobot": {
21+
"message": "Open XRobot"
2222
},
23-
"homepage.feature2.title": {
24-
"message": "Complete Ecosystem"
23+
"homepage.versionCard.eyebrow": {
24+
"message": "Documentation Baseline"
2525
},
26-
"homepage.feature2.content": {
27-
"message": "Development supports both Windows and Linux, with Docker images available to enable modular design and automated workflows."
26+
"homepage.guide.onboarding.title": {
27+
"message": "Onboarding Tasks"
2828
},
29-
"homepage.feature3.title": {
30-
"message": "Powerful Features"
29+
"homepage.guide.onboarding.desc": {
30+
"message": "Pick the right starting path by platform, then get familiar with XR design ideas and the basic coding style step by step."
3131
},
32-
"homepage.feature3.content": {
33-
"message": "From compatibility with peripherals and RTOS to kinematics and coordinate transformations, XRobot is like a Swiss Army knife for development."
32+
"homepage.guide.agent.title": {
33+
"message": "Agent Quick Start"
3434
},
35-
"homepage.feature4.title": {
36-
"message": "Open Source Collaboration"
35+
"homepage.guide.agent.desc": {
36+
"message": "A one-page startup context for a dedicated XRobot / LibXR assistant: identify the repository role first, then jump into the right docs and code entry points."
3737
},
38-
"homepage.feature4.content": {
39-
"message": "Contributors are welcome to improve and expand the content together for a better XRobot."
38+
"homepage.panel.eyebrow": {
39+
"message": "Document Entry Map"
4040
},
41-
"homepage.versionTitle": {
42-
"message": "Current repository versions"
41+
"homepage.panel.title": {
42+
"message": "Jump straight into the docs from the task at hand"
43+
},
44+
"homepage.route.xrobot.title": {
45+
"message": "Project & Workflow"
46+
},
47+
"homepage.route.xrobot.desc": {
48+
"message": "Package management, project management, code generation, and the day-to-day development flow."
49+
},
50+
"homepage.route.core.title": {
51+
"message": "Core Semantics"
52+
},
53+
"homepage.route.core.desc": {
54+
"message": "Callbacks, events, messages, time, memory, and the foundational abstractions."
55+
},
56+
"homepage.route.driver.title": {
57+
"message": "Drivers & XRUSB"
58+
},
59+
"homepage.route.driver.desc": {
60+
"message": "Peripheral abstractions, platform implementations, and XRUSB as part of the driver layer."
61+
},
62+
"homepage.route.start.title": {
63+
"message": "Environment & Getting Started"
64+
},
65+
"homepage.route.start.desc": {
66+
"message": "Platform selection, environment setup, and the first demo."
67+
},
68+
"homepage.quick.eyebrow": {
69+
"message": "Quick Paths"
70+
},
71+
"homepage.quick.title": {
72+
"message": "Enter by common task"
73+
},
74+
"homepage.quick.desc": {
75+
"message": "This section answers not \"how the docs are divided\", but \"what problem you are solving right now\"."
76+
},
77+
"homepage.path.intro.title": {
78+
"message": "I am new to LibXR / XRobot"
79+
},
80+
"homepage.path.intro.desc": {
81+
"message": "Start with the overall concepts, repository structure, and the smallest working path before deciding which layer to dive into."
82+
},
83+
"homepage.path.core.title": {
84+
"message": "I want to port to a new hardware platform"
85+
},
86+
"homepage.path.core.desc": {
87+
"message": "Start from driver abstractions, platform implementation, and basic peripheral capabilities to understand the board-level foundation first."
88+
},
89+
"homepage.path.driver.title": {
90+
"message": "I need to work on device-side interfaces and links"
91+
},
92+
"homepage.path.driver.desc": {
93+
"message": "Start from device interfaces, protocol stacks, and transport implementations, then look at communication, identification, and update-related content."
94+
},
95+
"homepage.path.usb.title": {
96+
"message": "I want to get the project running quickly"
97+
},
98+
"homepage.path.usb.desc": {
99+
"message": "First determine whether this is an XRobot workspace or a plain LibXR project. If you want the Agent to identify the entry path first, use the prompt on the homepage."
100+
},
101+
"homepage.recent.eyebrow": {
102+
"message": "Recent Direction"
103+
},
104+
"homepage.recent.title": {
105+
"message": "Recent Development"
106+
},
107+
"homepage.recent.desc": {
108+
"message": "This section shows directions that have recently started or are actively moving, so you can quickly see which capabilities are being expanded."
109+
},
110+
"homepage.recent.core.title": {
111+
"message": "MSPM0 / HPM5301 support is underway"
112+
},
113+
"homepage.recent.core.desc": {
114+
"message": "New platform adaptation has started, and basic drivers such as GPIO, UART, and PWM will be filled in step by step."
115+
},
116+
"homepage.recent.linux.title": {
117+
"message": "XRUSB device protocol stacks continue to expand"
118+
},
119+
"homepage.recent.linux.desc": {
120+
"message": "Existing device-side protocol stack support is still being completed, with more device communication and transport support on the way."
121+
},
122+
"homepage.recent.usb.title": {
123+
"message": "SWD support is expanding, and DapLink is moving toward JTAG"
124+
},
125+
"homepage.recent.usb.desc": {
126+
"message": "Both push-pull and open-drain SWD implementations are being adapted to more hardware, while the DapLink side continues to move toward JTAG support."
127+
},
128+
"homepage.focus.eyebrow": {
129+
"message": "Focus Areas"
130+
},
131+
"homepage.focus.title": {
132+
"message": "First decide what kind of problem you are solving"
133+
},
134+
"homepage.focus.desc": {
135+
"message": "Most problems fall into these three categories: understanding the mechanisms, connecting hardware, or getting the project running."
136+
},
137+
"homepage.focus.core.title": {
138+
"message": "When you are figuring out how the system works"
139+
},
140+
"homepage.focus.core.desc": {
141+
"message": "Start from callbacks, events, messages, and middleware relationships, and understand the internal runtime first."
142+
},
143+
"homepage.focus.driver.title": {
144+
"message": "When you are wiring hardware and doing platform bring-up"
145+
},
146+
"homepage.focus.driver.desc": {
147+
"message": "Start from drivers, platform implementation, XRUSB, and debug links to understand how boards, peripherals, and interfaces are brought in."
148+
},
149+
"homepage.focus.project.title": {
150+
"message": "When you are trying to get the project running"
151+
},
152+
"homepage.focus.project.desc": {
153+
"message": "Let the Agent identify the repository type first, then choose the workspace, platform-project, or driver entry path so the initialization flow starts from the right place."
154+
},
155+
"homepage.foot.eyebrow": {
156+
"message": "Project"
157+
},
158+
"homepage.foot.title": {
159+
"message": "Project Background & Community"
160+
},
161+
"homepage.foot.desc": {
162+
"message": "This section holds the project background, how to contribute, and community entry points, so you can understand the project itself before going deeper into the technical material."
43163
},
44164
"theme.ErrorPageContent.title": {
45165
"message": "This page crashed.",

‎i18n/en/docusaurus-plugin-content-pages/index.tsx‎

Lines changed: 1 addition & 145 deletions
Original file line numberDiff line numberDiff line change
@@ -1,145 +1 @@
1-
import React from 'react';
2-
import Layout from '@theme/Layout';
3-
import Link from '@docusaurus/Link';
4-
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
5-
import Translate, { translate } from '@docusaurus/Translate';
6-
import { motion } from 'framer-motion';
7-
import commitInfo from '../../../src/data/commitInfo.json';
8-
import '../../../src/pages/Home.css';
9-
10-
export default function Home(): JSX.Element {
11-
const { siteConfig } = useDocusaurusContext();
12-
13-
return (
14-
<Layout
15-
title={translate({ message: 'Home', id: 'homepage.title' })}
16-
description={translate({
17-
message: 'Documentation homepage for the XRobot project',
18-
id: 'homepage.description',
19-
})}
20-
>
21-
<main>
22-
<div className="animated-background" />
23-
<section className="hero hero--primary">
24-
<div className="container">
25-
<motion.img
26-
src="/img/XRobot.png"
27-
alt="XRobot Logo"
28-
initial={{ opacity: 0 }}
29-
animate={{ opacity: 1 }}
30-
transition={{ duration: 1 }}
31-
style={{ width: '240px', marginBottom: '1rem' }}
32-
/>
33-
34-
<motion.h1
35-
className="hero__title typewriter"
36-
initial={{ opacity: 0, y: 30 }}
37-
animate={{ opacity: 1, y: 0 }}
38-
transition={{ duration: 0.8 }}
39-
>
40-
<Translate id="homepage.heroTitle">Welcome to XRobot</Translate>
41-
</motion.h1>
42-
43-
<motion.p
44-
className="hero__subtitle"
45-
initial={{ opacity: 0, y: 20 }}
46-
animate={{ opacity: 1, y: 0 }}
47-
transition={{ delay: 0.3, duration: 0.8 }}
48-
>
49-
<Translate id="homepage.heroSubtitle">
50-
A documentation and tutorial platform for robotics/embedded developers.
51-
</Translate>
52-
</motion.p>
53-
54-
<motion.div
55-
className="buttons"
56-
style={{ display: 'flex', gap: '1.5rem', justifyContent: 'center', flexWrap: 'wrap' }}
57-
initial={{ opacity: 0, scale: 0.95 }}
58-
animate={{ opacity: 1, scale: 1 }}
59-
transition={{ delay: 0.6, duration: 0.6 }}
60-
>
61-
<Link
62-
className="button button--secondary button--lg"
63-
to="/docs/intro"
64-
>
65-
<Translate id="homepage.getStarted">Get Started</Translate>
66-
</Link>
67-
68-
<Link
69-
className="button button--secondary button--lg"
70-
to="https://xrobot-org.github.io/libxr_web_demo/index_en.html"
71-
>
72-
<Translate id="homepage.onlineDemo">Online Demo</Translate>
73-
</Link>
74-
</motion.div>
75-
</div>
76-
</section>
77-
78-
<section className="features">
79-
<div className="container">
80-
<div className="row">
81-
<div className="col col--3">
82-
<h3>
83-
<Translate id="homepage.feature1.title">Documentation Support</Translate>
84-
</h3>
85-
<p>
86-
<Translate id="homepage.feature1.content">
87-
Organize all kinds of project content in a modular way—from environment setup to advanced usage—making it easy to maintain and browse.
88-
</Translate>
89-
</p>
90-
</div>
91-
<div className="col col--3">
92-
<h3>
93-
<Translate id="homepage.feature2.title">Complete Ecosystem</Translate>
94-
</h3>
95-
<p>
96-
<Translate id="homepage.feature2.content">
97-
Development environments support both Windows and Linux, with Docker images to enable modular design and automation.
98-
</Translate>
99-
</p>
100-
</div>
101-
<div className="col col--3">
102-
<h3>
103-
<Translate id="homepage.feature3.title">Powerful Features</Translate>
104-
</h3>
105-
<p>
106-
<Translate id="homepage.feature3.content">
107-
From supporting various peripherals and RTOSes to coordinate transformations and kinematic solvers, XRobot is your Swiss army knife for development.
108-
</Translate>
109-
</p>
110-
</div>
111-
<div className="col col--3">
112-
<h3>
113-
<Translate id="homepage.feature4.title">Open Source Collaboration</Translate>
114-
</h3>
115-
<p>
116-
<Translate id="homepage.feature4.content">
117-
Contributors are welcome to help expand and improve content—let’s build a better XRobot together.
118-
</Translate>
119-
</p>
120-
</div>
121-
</div>
122-
</div>
123-
</section>
124-
125-
<section className="container margin-top--lg">
126-
<h2>
127-
<Translate id="homepage.versionTitle">Current Repository Versions</Translate>
128-
</h2>
129-
<ul>
130-
XRobot: <code>{commitInfo.XRobot || 'N/A'}</code>{' '}
131-
libxr: <code>{commitInfo.LibXR || 'N/A'}</code>{' '}
132-
LibXR_CppCodeGenerator: <code>{commitInfo.CodeGen || 'N/A'}</code>
133-
</ul>
134-
</section>
135-
136-
<section className="container margin-top--lg">
137-
<ul>
138-
This documentation only includes usage guides and coding tutorials.
139-
For API references and CLI tools, please see the Documents section in the footer.
140-
</ul>
141-
</section>
142-
</main>
143-
</Layout>
144-
);
145-
}
1+
export {default} from '../../../src/pages/index';

0 commit comments

Comments
 (0)