菜单
Commit documentation changes to git after reviewing and confirming.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Analyze documentation for duplicates, outdated content, and discrepancies with codebase
Expert-level documentation bootstrap using Diátaxis framework and audience-driven planning.
Quick health check for documentation issues. Verifies content against actual source files.
Create new documentation pages interactively. Searches codebase to ensure accuracy.
Delete documentation pages interactively with confirmation.
Import and configure API specification (OpenAPI, GraphQL, AsyncAPI) for documentation
| name | commit-doc |
| description | Commit documentation changes to git after reviewing and confirming. |
When user wants to commit documentation changes:
Run git status to see what's changed:
git status
git diff --stat
Show summary to user:
"Documentation Changes Ready to Commit:
Modified files (3):
docs/guides/authentication.mdx - Updated code examplesdocs/api/users.mdx - Added new endpoint docsdocs.json - Updated navigationNew files (1):
docs/guides/webhooks.mdx - New webhook guideDeleted files (1):
docs/old/deprecated-api.mdx - Removed deprecated docsWould you like to:
Show meaningful diff summary:
"Changes in docs/guides/authentication.mdx:
- const token = auth.getToken(user);
+ const token = await auth.getToken(user, { refresh: true });
Added:
refresh parameter documentationChanges in docs.json:
Continue to commit?"
Analyze changes and suggest a commit message:
"Suggested commit message:
docs: update authentication guide and add webhooks documentation
- Update auth.getToken() examples with new refresh parameter
- Add webhook integration guide
- Remove deprecated API documentation
- Update navigation structure
Options:
"Ready to commit with message:
docs: update authentication guide and add webhooks documentation
This will commit:
Proceed with commit? (yes/no)"
git add docs/
git add docs.json
git commit -m "docs: update authentication guide and add webhooks documentation
- Update auth.getToken() examples with new refresh parameter
- Add webhook integration guide
- Remove deprecated API documentation
- Update navigation structure"
"✓ Committed successfully!
Commit: abc1234
Branch: main
Files: 5 changed
Next steps:
git push origin mainnpm run deployWould you like me to push the changes?"
<type>: <short description>
<detailed description>
<list of changes>
docs: - Documentation changes (most common)fix: - Fix documentation errorsfeat: - New documentation featuresrefactor: - Reorganize documentationchore: - Maintenance tasksNew documentation:
docs: add webhook integration guide
- Add complete webhook setup guide
- Include payload examples
- Add troubleshooting section
Update existing:
docs: update authentication examples for v2.0
- Update code examples to use async/await
- Add new refresh token parameter
- Fix deprecated method references
Fix errors:
fix(docs): correct API endpoint URLs
- Fix base URL from /v1 to /v2
- Update authentication header name
- Fix typos in error codes
Reorganize:
refactor(docs): reorganize guide structure
- Move tutorials to dedicated folder
- Update navigation hierarchy
- Add cross-references between guides
When user wants to commit specific files:
"Select files to commit:
[ ] docs/guides/authentication.mdx
[ ] docs/api/users.mdx
[ ] docs/guides/webhooks.mdx
[x] docs.json
Enter file numbers to toggle (e.g., '1,3' or 'all'):"
After selection:
git add docs.json
git add docs/guides/webhooks.mdx
git commit -m "docs: add webhooks guide and update navigation"