Agent Skills
› bagofwords1/bagofwords
› docs-update
docs-update
GitHub用于在产品功能上线后更新Mintlify文档,包括定位受影响页面、使用本地环境捕获最新截图并替换旧图、修正正文与元数据,确保文档准确反映用户可见行为。
Trigger Scenarios
用户可见的功能变更已合并
请求更新或刷新产品文档
Install
npx skills add bagofwords1/bagofwords --skill docs-update -g -y
SKILL.md
Frontmatter
{
"name": "docs-update",
"description": "Update the product docs at docs.bagofwords.com (Mintlify) with text and fresh screenshots after a user-facing change ships. Use when a merged change alters user-visible behavior, adds a feature, or when asked to update\/refresh documentation."
}
Docs Update — Mintlify + fresh screenshots
The product docs live on Mintlify (docs.bagofwords.com), managed through the
Mintlify MCP server — not in this repo. docs/ here contains internal
design docs only.
When to run
After a user-facing change merges: new feature, changed flow, renamed UI, changed configuration. Skip for internal refactors.
Flow
- Find what's affected. With the Mintlify MCP:
checkoutthe deployment (this opens an isolated editing session/branch — surface the returnededitorUrlto the user), thensearch/read/list_nodesfor pages mentioning the touched feature. List affected pages before editing. - Capture fresh screenshots of the new behavior from a seeded local stack
(see the ui-evidence skill for the full capture procedure):
Stage them undertools/agent/boot_stack.sh && cd backend && uv run python ../tools/agent/seed_org.py --demo cd ../frontend && node ../tools/agent/capture.mjs http://localhost:3000/<page> shot.pngdocs/screenshots/pending-changes/<page-slug>/in this repo so they're reviewable alongside the docs PR. Match the style of existing docs images (clean seeded data, 1440px wide, no dev toolbars). - Edit pages via the session tools:
- body text →
edit_page(string replace) orwrite_page(full rewrite) - frontmatter (title, description, icon) →
update_node, neveredit_page - new pages / navigation →
create_node; site config →update_config
- body text →
- Images: if the MCP session cannot upload binary images, reference the
staged files and note in the docs PR description that the images in
docs/screenshots/pending-changes/<page-slug>/must be uploaded via the Mintlify editor (editorUrl) before merge. Do not publish pages pointing at broken image paths. - Review the diff (
diff/get_session_state), thensave— this opens a docs PR. Never use Mintlify code-mode (execute_code) for content work: it writes straight to the live deployment with no PR safety net. - Report back: affected pages, the docs PR link, and the
editorUrl.
Writing rules
- Describe what the user sees now — don't narrate the change ("previously…", "as of this release…") unless editing a changelog page.
- Verify every claim against the running app you just booted, not against the code diff — docs describe behavior, and this catches half-shipped UI.
- Screenshots must come from seeded sandbox data only — never real customer names, tokens, or connection strings.
- Keep terminology consistent with the app's locale catalogs
(
locales/en.json) — the UI string is the source of truth for feature names.
Version History
- 1529fca Current 2026-08-20 15:41


