strapi/documentation

pitfalls-add

Add a new entry to the known-pitfalls catalog that pitfalls-check audits against. Verifies the correct pattern against the Strapi source before adding, and confirms with the user. Use when you have found a documentation mistake worth catching automatically in…

原文语言：英语

review

Top-level review orchestrator: runs style-check, outline-check, outline-ux-analyzer, code-verify, coherence-check, and pitfalls-check on a file, directory, or PR.

原文语言：英语

pr

Create a pull request on strapi/documentation following git-rules.md. Strict flat-text description, no headings, no test plan.

原文语言：英语

document

End-to-end documentation orchestrator: chains all four inki phases (research, write, review, submit) for a single subject. Gates between each phase by default; --non-interactive chains without pauses and runs a review-fix loop. The simplest way to document a…

原文语言：英语

outline

Generate an outline for a new documentation page from a topic brief and the appropriate template.

原文语言：英语

pr-fix

Rewrite the title or description/body of one or more open PRs on strapi/documentation to match git-rules.md. Strict one-by-one confirmation, or auto-edit with --non-interactive.

原文语言：英语

submit

Top-level orchestrator: branch (if needed), commit, push, then open a PR. Each step asks for confirmation before continuing, unless --non-interactive is passed.

原文语言：英语

write

Top-level write orchestrator: outline a new page, get user approval, then draft from the outline.

原文语言：英语

code-verify

Verify code blocks in a documentation file: check syntax, references, and consistency with the underlying Strapi APIs.

原文语言：英语

coherence-check

Check a documentation file for cross-page coherence: terminology, links, and consistency with related pages.

原文语言：英语

coverage

Audit the documentation coverage of a Strapi feature or module: list what is documented vs missing.

原文语言：英语

draft

Draft a documentation page from an approved outline, the matching template, and the relevant authoring guide.

原文语言：英语

exists

Check whether a documentation topic is already covered on strapi/documentation: searches llms.txt, doc files, sidebars, and open GitHub PRs.

原文语言：英语

outline-check

Check the structural outline of a documentation page: heading hierarchy, section order, completeness against the template.

原文语言：英语

outline-ux-analyzer

Analyze the pedagogical UX of a documentation outline: progression from beginner to advanced, signposting, and reading flow.

原文语言：英语

pitfalls-check

Audit a documentation file against the known-pitfalls list: common mistakes, outdated patterns, deprecated APIs.

原文语言：英语

research

Top-level research orchestrator: combines exists, route, and coverage to give a complete picture before writing.

原文语言：英语

route

Given a strapi/strapi or strapi/cloud PR, identify which documentation pages and sections must be updated to cover the change.

原文语言：英语

style-check

Run deterministic style checks on a documentation file or directory, then layer AI judgment on top using the migrated style-checker prompt.

原文语言：英语

branch

Create a new branch in strapi/documentation with auto-detected prefix (cms/, cloud/, repo/) based on the files that will be touched.

原文语言：英语

commit

Stage and commit documentation changes in strapi/documentation. Enforces git-rules.md, protected paths, and branch prefix detection.

原文语言：英语

push

Push the current branch in strapi/documentation to origin. Validates branch name against git-rules.md conventions.

原文语言：英语