Skip to main content

docs-automation

Automate docs updates and command documentation generation. Use for generate-command-docs, enhance-command-docs, sidebar generation, and VitePress build checks.

来源信息

仓库
SAP-samples/hana-developer-cli-tool-example
最近来源活动
2026年5月18日 16:58
检测到的 SKILL.md 语言
英语
星标
114
分支
29

安装方式

默认使用会先检查来源的 Prompt;你也可以切换为直接命令,或下载本地副本。

检查来源文件

决定是否安装前,请先阅读 SKILL.md,以及 SkillsMP 当前展示的配套文件。

文件资源管理器
2 个文件

正在显示 SKILL.md

SKILL.md
来源说明 · 只读预览
name
docs-automation
description
Automate docs updates and command documentation generation. Use for generate-command-docs, enhance-command-docs, sidebar generation, and VitePress build checks.
argument-hint
Doc scope + intent (e.g., update command docs for data-sync, regenerate sidebar)
user-invocable
true
# Docs Automation Skill Use this skill for documentation generation and maintenance tasks. ## When to Use - Regenerating command documentation in `docs/02-commands/` - Enhancing command docs after generation - Updating or regenerating the VitePress sidebar - Validating doc builds and link consistency ## Procedure 1. Identify the docs scope (all commands vs specific folders). 2. Run the relevant automation scripts: - `scripts/generate-command-docs.js` - `scripts/enhance-command-docs.js` - `scripts/populate-command-docs.js` - `scripts/generate-sidebar-config.js` or `scripts/generate-sidebar-config-fixed.js` 3. Spot-check updated markdown for formatting and taxonomy alignment. 4. If needed, run `vitepress build docs` to validate the output. ## Notes - Follow the command documentation instructions for `docs/02-commands/`. - Preserve existing category names and ordering in the sidebar. - Use existing scripts rather than manual edits whenever possible. ## References - [Docs automation checklist](./references/checklist.md)
在 GitHub 查看