init
Set up docflow in a repo with no docs yet: scaffold the docs tree, write docflow.json, add agent guidance. Use when asked to "set up docflow", "initialize docs", "scaffold docs", or "make this repo use docflow".
- License 许可
- Apache-2.0
- 最近更新
- 2026-11-13
- Stars
- ★ 1.6k
- Forks
- 483
01 前言 Front Matter
- name
- init
- description
- Set up docflow in a repo with no docs yet: scaffold the docs tree, write docflow.json, add agent guidance. Use when asked to "set up docflow", "initialize docs", "scaffold docs", or "make this repo use docflow".
03 SKILL.md 正文
init
Goal: initialize docflow only when doctor says this repo has no meaningful docs yet. Keep existing user-authored files; generated maintenance files may be refreshed.
Steps
- Run doctor first.
bash scripts/docflow-doctor.sh --target <REPO ROOT>
-
Route by recommendation.
docflow-init: continue.docflow-adopt: stop and run/docflow:adoptinstead (preserves existing docs).docflow-repair: stop and run/docflow:repairinstead.
-
Pick docs root.
- Use
docs/unless the user explicitly chooses another root.
- Use
-
Pick project name.
- Prefer repo folder name.
- If root
README.mdhas clear project title, use that.
-
Run scaffold from plugin root (idempotent; skips existing user content, refreshes generated files):
bash scripts/scaffold.sh --docs-root <DOCS_ROOT> --project "<PROJECT NAME>" --target "<REPO ROOT>"
This creates the category tree, drops templates, writes docflow.json, and scaffolds AGENTS.md + GEMINI.md + .cursorrules.
-
Add root README link if missing:
## Documentation- link to
<DOCS_ROOT>/README.md
-
Seed the first changelog. Create
<DOCS_ROOT>/changelog/(mmm-yy).mdfor the current month from the template, summarizing recent history (git log --no-merges --pretty='%h %ad %s' --date=short -20). Use thechangelogskill for the format. -
Regenerate the map and validate:
bash scripts/docflow-map.sh "<REPO ROOT>/<DOCS_ROOT>" bash scripts/docflow-validate.sh --target "<REPO ROOT>"Fresh template placeholders are warnings; validation errors are blockers.
-
Report what was created (docs root,
docflow.json,AGENTS.md,GEMINI.md,.cursorrules, validation status) and point the user at/docflow:author(writing),/docflow:router(reading),/docflow:validate(readiness),/docflow:repair(maintenance).
Rules
- Never overwrite existing user-authored docs files.
- If docs already exist, prefer
/docflow:adoptover/docflow:init. - Keep
AGENTS.mdanddocflow.jsonaligned on docs root. - Follow the naming rules in
<DOCS_ROOT>/NAMING.mdfor every file you create after.
04 同仓库更多 Skills
migrate-to-e2e
Moves an existing Playwright, Cypress, Selenium, Appium, Detox, Maestro, or TesterArmy suite to e2e one slice at a time, with the old suite running beside the new one until each ported test is proven. Keeps a MIGRATION.md progress file so any later session resumes where the last stopped. Optionally plants a defect to show both suites catch it. Use for /migrate-to-e2e, "migrate our tests to e2e", "port these Maestro flows", "move our TesterArmy tests", or when a project has an e2e config and an older suite still running.
e2e
Writes, runs, and debugs end-to-end tests for web and mobile apps with e2e, the agentic test runner, which mixes agent.act goals with exact locator assertions on a Playwright browser or an iOS or Android device. Also drives a project's running app live over the e2e MCP server to look at a screen, check a UI change, take a screenshot or record a video, and try a locator; and runs bug bashes, parallel e2e explore runs with each bug proven by a repro test. Use when a project depends on e2e or has an e2e.config.ts, when asked for end-to-end, browser, mobile, or agentic UI tests, to check a change in the running app, to QA or bug bash an app or branch, or when an e2e run fails.
create-verification-skill
Generate a project-local verify-<app> skill on top of e2e, so any coding agent can launch the app, check it is worth driving, exercise a feature the way a user does, keep evidence, and bug bash it. Writes the skill, a feature map with one explore charter per feature, and proves it once. Use for /create-verification-skill, "make a verification skill for this repo", or when a project has no scripted way to prove UI behavior.
deja-search
deja-vu memory — search the user's past AI coding sessions with the deja CLI. Holds what they already settled and never wrote into the repo (naming rules, banned or already-tried tools, required checks before merge, preferred values, who owns what). Use before your first edit in a task, before you call a change done or ready to merge, before you recommend a tool, library, design or reviewer, before re-debugging an error that may already be solved, when they say 'didn't we fix this before', 'what did we decide about X' or 'I already have that', and before telling them something on this machine does not exist.
deja-reflect
End-of-session reflection and memory curation with deja-vu. Review what was decided, what commands broke and what repaired them, and record durable project rules or decisions with deja remember so the next session starts with them.
revid
Make, edit, export and post AI videos with Revid (revid.ai) through the Revid MCP server. Use whenever the user wants a short-form or long-form video made (from an idea, a script, a URL, an article, a PDF, a tweet, a product page, their own clips, or a song), wants to find what is going viral on TikTok, YouTube, Instagram or X before making something, wants to edit or re-export an existing Revid project, generate a standalone AI image or clip, make a series episode, or publish and schedule a finished video to connected social accounts. Covers setup (hosted MCP with OAuth, or an API key), the 36 tools, credits, polling and the rules for publishing. Routes to the more specific revid-* skills when one fits.