Skip to content

Commit 46dc646

Browse files
dimo333dimo333
authored
Fix hmi docs (#37)
* delate video-guide docs * delete supported-hardware docs * Add Supported_Hardware docs * Delete realease-notes docs * Add Release-Notes docs * Fix Workspace docs * Delete guides docs * Delete pricing docs * Add Overview docs * Add guides docs * Fix config * Fix Overview docs * Fix hmi ai_gen * Fix hmi overview * Fix hmi support_hardware * Fix hmi release_note * Fix hmi workspace * Fix hmi getting_start * Fix hmi index_mdx * Fix hmi docs
1 parent 1f93dcc commit 46dc646

23 files changed

Lines changed: 931 additions & 3419 deletions

‎astro.config.mjs‎

Lines changed: 31 additions & 170 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,24 @@ export default defineConfig({
4343
},
4444
lastUpdated: true,
4545
sidebar: [
46+
{
47+
label: 'Overview',
48+
link: '/overview/',
49+
translations: {
50+
'zh-CN': '概览',
51+
'ja': '概要',
52+
'es': 'Descripción general',
53+
},
54+
},
55+
{
56+
label: 'Supported Hardware',
57+
link: '/supported_hardware/',
58+
translations: {
59+
'zh-CN': '支持的硬件',
60+
'ja': 'サポートされているハードウェア',
61+
'es': 'Hardware compatible',
62+
},
63+
},
4664
{
4765
label: 'Guides',
4866
translations: {
@@ -53,198 +71,41 @@ export default defineConfig({
5371
items: [
5472
{
5573
label: 'Getting Started',
56-
link: '/guides/getting-started/',
57-
translations: {
58-
'zh-CN': '快速入门',
59-
'ja': 'はじめに',
60-
'es': 'Primeros pasos',
61-
},
74+
link: '/guides/getting_started/',
75+
translations: {
76+
'zh-CN': '快速入门',
77+
'ja': 'はじめに',
78+
'es': 'Primeros pasos',
79+
},
6280
},
6381
{
6482
label: 'Workspace',
83+
link: '/guides/workspace/',
6584
translations: {
6685
'zh-CN': '工作区',
6786
'ja': 'ワークスペース',
6887
'es': 'Espacio de trabajo',
6988
},
70-
// 使用 items 数组让它在侧边栏变成一个“文件夹”
71-
items: [
72-
// {
73-
// label: 'Introduction', // 这是 index.md 在菜单里显示的名称
74-
// link: '/guides/workspace/', // 对应 guides/Workspace/index.md
75-
// translations: {
76-
// 'zh-CN': '简介',
77-
// },
78-
// },
79-
{
80-
label: 'Data Advanced Usage',
81-
link: '/guides/workspace/data-usage', // 对应 workspace/data-advanced-usage.md
82-
translations: {
83-
'zh-CN': '数据高级用法',
84-
'ja': 'データの高度な使用法',
85-
'es': 'Uso avanzado de datos',
86-
},
87-
},
88-
{
89-
label: 'RSS Advanced Usage',
90-
link: '/guides/workspace/sensecraft-hmi-rss',
91-
translations: {
92-
'zh-CN': 'RSS 功能',
93-
'ja': 'RSS 機能',
94-
'es': 'Función RSS',
95-
},
96-
},
97-
{
98-
label: 'Web Content Advanced Usage',
99-
link: '/guides/workspace/sensecraft-hmi-web',
100-
translations: {
101-
'zh-CN': '网页功能',
102-
'ja': 'Web 機能',
103-
'es': 'Función Web',
104-
},
105-
},
106-
],
107-
},
108-
// {
109-
// label: 'Firmware Update and Flashing',
110-
// link: '/guides/firmware-update/',
111-
// translations: {
112-
// 'zh-CN': '固件更新和刷写',
113-
// 'ja': 'ファームウェアアップデートとフラッシュ',
114-
// 'es': 'Actualización y flasheo de firmware',
115-
// },
116-
// },
117-
// {
118-
// label: 'Workspace Interface & Templates',
119-
// link: '/guides/workspace-interface/',
120-
// translations: {
121-
// 'zh-CN': '工作区界面和模板',
122-
// 'ja': 'ワークスペースインターフェースとテンプレート',
123-
// 'es': 'Interfaz del espacio de trabajo y plantillas',
124-
// },
125-
// },
126-
{
127-
label: 'Tools',
128-
link: '/guides/advanced-tools/',
129-
translations: {
130-
'zh-CN': '高级工具',
131-
'ja': '高度なツール',
132-
'es': 'Herramientas avanzadas',
133-
},
134-
},
135-
// {
136-
// label: 'AI Generation Function',
137-
// link: '/guides/sensecraft-hmi-ai-generator/',
138-
// translations: {
139-
// 'zh-CN': 'AI 生成功能',
140-
// 'ja': 'AI 生成機能',
141-
// 'es': 'Función de generación con IA',
142-
// },
143-
// },
144-
// {
145-
// label: 'Gallery Function',
146-
// link: '/guides/sensecraft-hmi-gallery/',
147-
// translations: {
148-
// 'zh-CN': '图库功能',
149-
// 'ja': 'ギャラリー機能',
150-
// 'es': 'Función de galería',
151-
// },
152-
// },
153-
// {
154-
// label: 'Canvas Function',
155-
// link: '/guides/sensecraft-hmi-canvas/',
156-
// translations: {
157-
// 'zh-CN': 'UI 设计功能',
158-
// 'ja': 'UI 設計機能',
159-
// 'es': 'Función Canvas',
160-
// },
161-
// },
162-
// {
163-
// label: 'Deploying to Your Device',
164-
// link: '/guides/deploying-to-device/',
165-
// translations: {
166-
// 'zh-CN': '部署到设备',
167-
// 'ja': 'デバイスへのデプロイ',
168-
// 'es': 'Implementación en tu dispositivo',
169-
// },
170-
// },
171-
],
172-
},
173-
{
174-
label: 'Video Guide',
175-
translations: {
176-
'zh-CN': '视频指南',
177-
'ja': 'ビデオガイド',
178-
'es': 'Guía en video',
179-
},
180-
items: [
181-
{
182-
label: 'Video Guide',
183-
link: '/video-guide/',
184-
translations: {
185-
'zh-CN': '视频指南',
186-
'ja': 'ビデオガイド',
187-
'es': 'Guía en video',
188-
},
189-
},
190-
],
191-
},
192-
{
193-
label: 'Supported Hardware',
194-
translations: {
195-
'zh-CN': '支持的硬件',
196-
'ja': 'サポートされているハードウェア',
197-
'es': 'Hardware compatible',
198-
},
199-
items: [
200-
{
201-
label: 'Supported Hardware',
202-
link: '/supported-hardware/',
203-
translations: {
204-
'zh-CN': '支持的硬件',
205-
'ja': 'サポートされているハードウェア',
206-
'es': 'Hardware compatible',
207-
},
20889
},
209-
],
210-
},
211-
{
212-
label: 'Pricing',
213-
translations: {
214-
'zh-CN': '价格',
215-
'ja': '価格',
216-
'es': 'Precios',
217-
},
218-
items: [
21990
{
220-
label: 'Pricing',
221-
link: '/pricing/',
91+
label: 'AI Generation',
92+
link: '/guides/ai_gen/',
22293
translations: {
223-
'zh-CN': '价格',
224-
'ja': '価格',
225-
'es': 'Precios',
94+
'zh-CN': 'AI 生成',
95+
'ja': 'AI 生成',
96+
'es': 'Generación con IA',
22697
},
22798
},
22899
],
229100
},
230101
{
231102
label: 'Release Notes',
103+
link: '/release_note/',
232104
translations: {
233105
'zh-CN': '发布说明',
234106
'ja': 'リリースノート',
235107
'es': 'Notas de versión',
236108
},
237-
items: [
238-
{
239-
label: 'Release Notes',
240-
link: '/release-notes/',
241-
translations: {
242-
'zh-CN': '发布说明',
243-
'ja': 'リリースノート',
244-
'es': 'Notas de versión',
245-
},
246-
},
247-
],
248109
},
249110
],
250111
customCss: [

‎src/content/docs/en/Overview/index.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
description: Introduction to SenseCraft HMI — a no-code UI platform for ePaper displays. Learn about features, registration, firmware update, and how to deploy your first page.
3+
title: Overview
4+
5+
---
6+
7+
### Platform Introduction
8+
9+
**[SenseCraft HMI](https://sensecraft.seeed.cc/hmi)** is Seeed Studio's cloud-based UI design platform built specifically for ePaper display devices. It lets you create, customize, and deploy professional visual interfaces **without writing a single line of code**.
10+
11+
<div style={{textAlign:'center'}}>
12+
<img src="https://files.seeedstudio.com/wiki/hmi/img/hmi_overview_1.png" style={{width:'100%', maxWidth:'900px', height:'auto', borderRadius:'8px'}}/>
13+
</div>
14+
15+
---
16+
### Key Features:
17+
18+
- **No-code drag-and-drop designer** — build layouts visually with widgets, data sources, and custom elements
19+
- **Community template library** — browse and reuse designs published by the community
20+
- **Live data integration** — connect to Weather, Stock, SenseCAP sensors, Google Calendar, RSS feeds, and more
21+
- **AI-powered generation** — describe what you want in plain text and let AI generate the image or layout
22+
- **One-click deployment** — push your design directly to the device over Wi-Fi
23+
24+
---
25+
### Pricing
26+
27+
SenseCraft HMI is currently in **Beta** and is **free** to use.
28+
29+
While our platform is free to use, AI generation features are subject to certain usage limits.
30+
31+
- **Daily Limit**: Each account is limited to 10 AI-generated creations per day, including 5 image generation/adjustments and 5 canvas generation/adjustments.
32+
- **Reset Time**: Limits reset every 24 hours.
33+
---
34+
### Platform Registration
35+
36+
SenseCraft HMI uses the unified SenseCraft account system. You can sign in with an existing SenseCraft / SenseCAP / Google / GitHub account, or register a new one.
37+
38+
**Step 1.** Visit [sensecraft.seeed.cc/hmi](https://sensecraft.seeed.cc/hmi) and click **Log in** in the bottom-left corner.
39+
40+
<div style={{textAlign:'center'}}>
41+
<img src="https://files.seeedstudio.com/wiki/hmi/img/hmi_overview_2.png" style={{width:'100%', maxWidth:'900px', height:'auto', borderRadius:'8px'}}/>
42+
</div>
43+
44+
**Step 2.** You can sign in directly with SenseCraft / SenseCAP, or via your Google or GitHub account.
45+
46+
<div style={{textAlign:'center'}}>
47+
<img src="https://files.seeedstudio.com/wiki/hmi/img/hmi_overview_3.png" style={{width:'100%', maxWidth:'900px', height:'auto', borderRadius:'8px'}}/>
48+
</div>
49+
50+
**Step 3.** If you don't have an account yet, click **Sign up** at the bottom of the login page, enter your email and password, and then complete the email verification.
51+
52+
<div style={{textAlign:'center'}}>
53+
<img src="https://files.seeedstudio.com/wiki/reterminal_e10xx/sensecraft_hmi/start_2.png" style={{width:'100%', maxWidth:'900px', height:'auto', borderRadius:'8px'}}/>
54+
</div>
55+
56+
**Step 4.** Once logged in, you will land on the **Home** page of SenseCraft HMI.
57+
58+
---
59+
### Getting Started
60+
[Quick Start Guide](/en/guides/getting_started/)
61+
62+
### Documentation Directory
63+
64+
| Section | Description |
65+
| :--- | :--- |
66+
| **[Overview](/en/overview/)** | Platform introduction, features, pricing, supported hardware, registration, and quick start guide. |
67+
| **[Supported Hardware](/en/supported_hardware/)** | A complete list of compatible devices with purchase links and shortcuts to featured showcases/cases. |
68+
| **[Guides](/en/guides/getting_started/)** | Comprehensive tutorials covering quick start, device management, firmware flashing, canvas designer, and AI generation. |
69+
| **[Release Notes](/en/release_note/)** | Version history, latest updates, and changelogs. |
70+

src/content/docs/en/release-notes/index.md renamed to src/content/docs/en/Release_Note/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ We've expanded compatibility to support the newly released EE04 DIY Kit, offerin
233233
Supported Display Types:
234234
• Monochrome (black & white)
235235
• 4-color displays
236-
• 6-color displays (E Ink Spectra 6 Full-color)
236+
• 6-color displays (E Ink Spectra 6 Full-color)
237237

238238
<div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/reterminal_e10xx/sensecraft_hmi/update1.png" style={{width:800, height:'auto'}}/></div>
239239

0 commit comments

Comments
 (0)