菜单
Plans where TuyaOpen.io documentation should live, manages file paths and sidebar placement, and prevents URI breakage. Use when creating new docs, moving or renaming docs, updating sidebars.js, or planning documentation structure for TuyaOpen.io.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Senior SEO + GEO (Generative Engine Optimization) craft for the TuyaOpen.ai Docusaurus site. Use when auditing, writing, or fixing the search and AI-discovery surface of ANY page — docs (4 sidebars), JSX pages, /learn, blog, or the site config. Owns per-page <head> (title, description, keywords, OG/Twitter, canonical, robots), image alt text in Markdown and HTML/JSX, the bilingual (en + zh) keyword strategy, and the GEO layer (llms.txt, robots.txt, JSON-LD structured data, AI-crawler access, semantic content). Grounds every keyword and TDK string in the two seed CSVs (jump-start reference) or derives it from the page's real content when the CSVs don't cover it; never fabricates. Delegates build/render checks to tuyaopen-build-check, URL/redirect safety to tuyaopen-doc-planner, source grounding to tuyaopen-code-analyzer.
Senior technical-writer craft for the TuyaOpen.ai (TuyaOpen.io) Docusaurus site, across all four product pillars — SDK, Hardware, Cloud, and Agent (TuyaOpenClaw). Use when writing, revising, reviewing, or structuring any doc, tutorial, API reference, hardware guide, cloud/agent guide, or per-product overview on the site. Produces bilingual (en + zh), audience-tiered, single-concept, linear docs grounded in real source — never assumption. Delegates placement to tuyaopen-doc-planner, build/render checks to tuyaopen-build-check, and source grounding to tuyaopen-code-analyzer; this skill governs HOW the doc reads and WHICH product model it follows.
Verifies TuyaOpen.io Docusaurus documentation builds successfully and catches broken links, MDX syntax errors, and sidebar mismatches. Use when checking if doc changes build correctly, running the dev server, validating sidebar references, or checking i18n builds.
Deep-dive into TuyaOpen SDK codebase to extract documentation-worthy information. Use when analyzing TuyaOpen source code, identifying undocumented APIs, mapping code architecture, finding examples without docs, or planning documentation based on source code analysis.
Orchestrates the full TuyaOpen documentation automation loop from codebase analysis through planning, writing, building, and committing to feature branches. Use when running the doc workflow cycle, creating doc PRs, managing the agent-plan-workspace, or automating documentation updates for TuyaOpen.io.
Enforces unified writing style for TuyaOpen.io Docusaurus documentation across all doc types and audiences. Use when writing, editing, reviewing, or planning any doc, blog post, or project page for TuyaOpen. Covers tone, structure, audience targeting, i18n, mermaid usage, and image guidelines.
| name | tuyaopen-doc-planner |
| description | Plans where TuyaOpen.io documentation should live, manages file paths and sidebar placement, and prevents URI breakage. Use when creating new docs, moving or renaming docs, updating sidebars.js, or planning documentation structure for TuyaOpen.io. |
Plans documentation placement, manages sidebar integration, and preserves existing URIs. Read this before creating, moving, or renaming any doc.
When deciding where a new doc goes, follow this priority chain:
Is it platform-specific?
YES -> docs/hardware-specific/{platform}/
NO -> Is it a full application demo?
YES -> docs/applications/{area}/
NO -> Is it a focused code example?
YES -> docs/examples/
NO -> Is it a peripheral/driver doc?
YES -> docs/peripheral/
NO -> Is it about Tuya Cloud / AI Agent?
YES -> docs/cloud/tuya-cloud/
NO -> Is it a community project?
YES -> docs/projects/YYYY-MM-DD-slug.md
NO -> Is it a blog post?
YES -> blog/YYYY-MM-DD-slug.md
NO -> Is it an API reference?
YES -> docs/tkl-api/
NO -> Does it fit an existing category?
YES -> Place in that category
NO -> Propose new category to user
A doc is platform-specific if its steps, config, or hardware only apply to one board family. Examples:
docs/hardware-specific/tuya-t5/t5-ai-core/docs/hardware-specific/Linux/raspberry-pi/Troubleshooting/docs/hardware-specific/tuya-t5/develop-with-Arduino/A doc is shared if the same steps work across platforms (e.g., tos.py build workflow, generic GPIO example using TKL abstraction). Place shared docs in docs/examples/, docs/applications/, or docs/peripheral/.
| Content type | Path pattern | Example |
|---|---|---|
| App demo (cloud) | docs/applications/tuya_cloud/ | demo-tuya-iot-light.md |
| App demo (AI) | docs/applications/tuya.ai/ | demo-your-chat-bot.md |
| AI SDK component | docs/applications/tuya.ai/ai-components/ | ai-agent.md |
| Generic example | docs/examples/ | demo-generic-examples.md |
| Peripheral driver | docs/peripheral/ | display.md, audio.md |
| TKL API reference | docs/tkl-api/ | tkl_gpio.md |
| Cloud AI Agent | docs/cloud/tuya-cloud/ai-agent/ | workflow-management.md |
| Hardware guide | docs/hardware-specific/{platform}/ | nested by board |
| Arduino IDE | docs/hardware-specific/tuya-t5/develop-with-Arduino/ | Quick_start.md |
| Porting/new platform | docs/new-hardware/ | porting-platform.md |
| Build system | docs/build-system/ | compilation-guide.md |
| Tools | docs/tos-tools/ | tos-guide.md |
| Project page | docs/projects/YYYY-MM-DD-slug.md | also register in src/data/projects.js |
| Blog post | blog/YYYY-MM-DD-slug.md | also add author/tags if new |
| FAQ | docs/faqs/ | faqs.md |
| Contributing | docs/contribute/ | contribute-guide.md |
| Future (MiniApp, etc.) | docs/{new-category}/ | propose sidebar section |
The sidebar is defined in sidebars.js (root of repo). It has 12 major sections separated by HTML dividers:
.md extension, relative to docs/).items array of the correct category object.{
type: 'category',
label: 'Category Name',
collapsed: true,
items: ['path/to/doc-id'],
}
Category and link labels in sidebars.js are English only. The Chinese site reads translated labels from i18n/zh/docusaurus-plugin-content-docs/current.json. Whenever you add, rename, or remove a sidebar label (or a custom doc sidebar label), update that file in the same change set.
Translation key rules (Docusaurus docs sidebar id):
| Sidebar item | JSON key pattern | Notes |
|---|---|---|
type: 'category', label: 'X' | sidebar.docs.category.X | X must match the label string exactly (including &, commas, parentheses). |
type: 'link', label: 'X' | sidebar.docs.link.X | Same; use link.key in the sidebar if you need a stable key when labels collide. |
type: 'doc' with label: 'X' (custom sidebar text) | sidebar.docs.doc.X | If the item has key: 'my-key', use sidebar.docs.doc.my-key instead. |
HTML divider with sidebar-divider-en / sidebar-divider-zh spans | (none) | Chinese text lives in sidebars.js inside the zh span; src/styles/custom.css toggles by html[lang]. |
Each entry uses this shape:
"sidebar.docs.category.My Category": {
"message": "我的分类",
"description": "The label for category My Category in sidebar docs"
}
Checklist when editing sidebars.js:
label on categories, links, and custom-labeled doc items.sidebar.docs.category.*, sidebar.docs.link.*, or sidebar.docs.doc.* keys in current.json.docs/advanced-use/terminologies.md); keep do-not-translate terms (TuyaOpen, TKL, TAL, MCP, OpenAPI, etc.) as-is.Reuse tone and patterns from existing keys in the same file.
Before any rename or move:
Search for all references to the old path:
docs/**/*.md (links in other docs)i18n/zh/docusaurus-plugin-content-docs/current/**/*.mdsidebars.js (doc IDs)src/data/projects.js (markdownFile paths)src/pages/*.js (any hardcoded links)docusaurus.config.js (redirects, navbar)Update all references to the new path in the same change set.
Add a redirect in docusaurus.config.js under @docusaurus/plugin-client-redirects:
{
from: '/docs/old-path',
to: '/docs/new-path',
}
Prefer not moving. If a doc is in a reasonable location, leave it. Only move for strong structural reasons.
Every doc under docs/ should have a Chinese counterpart at:
i18n/zh/docusaurus-plugin-content-docs/current/{same-relative-path}
When creating a new doc:
docs/.title: should be translated in the zh version.When moving/renaming:
i18n/zh/docusaurus-plugin-content-docs/current.json if sidebar labels changed (see Sidebar label i18n (Chinese) under Sidebar Integration).my-new-guide.md (not MyNewGuide.md or my_new_guide.md)YYYY-MM-DD-project-slug.mdYYYY-MM-DD-slug.mdtkl_{module}.md (matching the C header name)When adding a project page:
docs/projects/YYYY-MM-DD-slug.md with <BackToProjects /> at topsrc/data/projects.js (both en and zh arrays)static/img/ or use external URLsrc/data/projects_tags.jsFor the full directory tree of the docs structure, see directory-map.md.