Skip to content

Commit 43e8a59

Browse files
Add docs search and prominent AI skill download links.
Enable local full-text search in the navbar with keyboard shortcut, add SkillDownloads cards on intro and AI workflow pages, and surface Cursor/Claude skill files in navbar, sidebar, and footer. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 1fba876 commit 43e8a59

17 files changed

Lines changed: 884 additions & 12 deletions

website/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,18 @@ docs/
2424

2525
Edit content in `docs/`. Run `npm run build` before deploy (`onBrokenLinks: throw`).
2626

27+
## Search
28+
29+
Local full-text search is enabled via `@easyops-cn/docusaurus-search-local` (navbar search box, `⌘K` / `Ctrl+K`).
30+
31+
## AI skills (Cursor / Claude)
32+
33+
Downloadable prompt files and setup notes:
34+
35+
- [Skill for Cursor](docs/for-cursor.mdx)`static/skills/cursor-skill.md`
36+
- [Skill for Claude](docs/for-claude.mdx)`static/skills/claude-skill.md`
37+
- Hub: [For Cursor Claude](docs/for-cursor-claude.md)
38+
2739
## Translation
2840

2941
- Docs are maintained in **English**.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,14 @@ title: Skill for Claude
33
description: Claude-oriented guide for SDK analysis, docs, and safe refactors
44
---
55

6+
import SkillDownloads from '@site/src/components/SkillDownloads';
7+
68
# Skill for Claude
79

810
Use this workflow when Claude is helping with VeltoKit, Triki UI, and game integration docs.
911

12+
<SkillDownloads />
13+
1014
## Analysis priorities
1115

1216
1. Build architecture context first:
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,21 @@ description: One-page operational hub for fast SDK work in Cursor
44
sidebar_position: 99
55
---
66

7+
import SkillDownloads from '@site/src/components/SkillDownloads';
8+
79
# For Cursor Claude
810

911
This page is a practical hub for AI-assisted development in this repository.
1012
Use it as a fast checklist before implementing, debugging, or documenting.
1113

14+
## Docs search
15+
16+
Use the **Search** field in the top navbar (keyboard: `⌘K` on macOS, `Ctrl+K` on Windows/Linux). It indexes all documentation pages and the homepage.
17+
18+
## Download AI skills {#download-ai-skills}
19+
20+
<SkillDownloads showHeading={false} />
21+
1222
## Fast orientation
1323

1424
- SDK core: `VeltoKit/`
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,14 @@ title: Skill for Cursor
33
description: Practical Cursor playbook for working with VeltoKit and Triki UI
44
---
55

6+
import SkillDownloads from '@site/src/components/SkillDownloads';
7+
68
# Skill for Cursor
79

810
Use this as a compact operating guide when developing in Cursor on this repository.
911

12+
<SkillDownloads />
13+
1014
## What to open first
1115

1216
1. `VeltoKit/MotionSDK.swift`

website/docs/intro.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,14 @@ description: VeltoKit — unofficial BLE motion SDK for iOS games
66
---
77

88
import Link from '@docusaurus/Link';
9+
import SkillDownloads from '@site/src/components/SkillDownloads';
910

1011
# VeltoKit
1112

1213
Experimental Swift layer: **reverse-engineered BLE cap controller → `GameInput`**. Learn how tilt, throw gestures, and button edges become game-ready fields every frame.
1314

15+
Use **Search** in the navbar (`⌘K` / `Ctrl+K`) to find topics. AI skill downloads are below and on [For Cursor Claude](./for-cursor-claude).
16+
1417
:::caution Independent project
1518
Unofficial implementation for **education and development**. Not affiliated with any hardware manufacturer or brand.
1619
:::
@@ -51,6 +54,12 @@ Each demo documents **VeltoKit mode**, **GameInput** fields, and **source files*
5154
| Connect controller in one call | [Quick start](quick-start) (`connect()` + `pollInput()`) |
5255
| Wire my own BLE stack | [BLE integration](sdk/ble-integration) |
5356
| Help — app, controller, TV | [Help](faq) |
57+
| Search all docs | Use the **Search** box in the top bar (`Ctrl/Cmd + K` on many browsers) |
58+
| Download Cursor / Claude skills | [Download AI skills](#download-ai-skills) on this page |
59+
60+
## Download AI skills {#download-ai-skills}
61+
62+
<SkillDownloads showHeading={false} />
5463

5564
## Repo layout
5665

website/docs/quick-start.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ description: Connect and read GameInput — VeltoKit
66

77
# Quick Start
88

9+
**Search docs:** use the **Search** box in the top navbar (`⌘K` / `Ctrl+K`).
10+
11+
**AI skills (Cursor / Claude):** download on [For Cursor Claude](./for-cursor-claude) or [Introduction](./intro) (download cards at the top).
12+
913
Add VeltoKit via [SPM or CocoaPods](installation), then:
1014

1115
## Simple flow (BLE built in)

website/docs/sdk/overview.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ description: VeltoKit — MotionSDK and GameInput
88

99
**VeltoKit** maps BLE motion bytes → **`GameInput`** each frame. No UI, no CoreBluetooth in the core target.
1010

11+
:::tip Docs search & AI skills
12+
Use **Search** in the top navbar (`⌘K` / `Ctrl+K`) to find any topic.
13+
Download Cursor / Claude prompt files on [For Cursor Claude](../for-cursor-claude#download-ai-skills) (footer: **AI skills (download)**).
14+
:::
15+
1116
## Integrate (MotionSDK)
1217

1318
**Simple path** — BLE scan + read each frame:

website/docusaurus.config.ts

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,20 @@ const config: Config = {
1818
onDuplicateRoutes: 'warn',
1919

2020
plugins: [
21+
[
22+
require.resolve('@easyops-cn/docusaurus-search-local'),
23+
{
24+
hashed: true,
25+
language: ['en'],
26+
docsRouteBasePath: 'docs',
27+
indexBlog: false,
28+
indexPages: true,
29+
highlightSearchTermsOnTargetPage: true,
30+
searchResultLimits: 12,
31+
searchBarShortcut: true,
32+
explicitSearchResultPath: true,
33+
},
34+
],
2135
[
2236
'@docusaurus/plugin-client-redirects',
2337
{

0 commit comments

Comments
 (0)