OpenParable
Skip to content
← Back to skills

Outline Check

Documents
outline-check

Outline Check is an Agent Skill for documents published in the strapi/documentation repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

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

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/strapi/documentation/blob/HEAD/claude-plugins/inki/skills/outline-check/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/outline-check, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

/inki:outline-check: outline structure audit

Step 1: Identify the target and its template

$ARGUMENTS is a relative path to a documentation page. Identify which template this page should match (feature, plugin, guide, API, configuration, breaking-change) by reading the page's frontmatter and content.

Logging: unless --no-log is passed, write this skill's report to the run log per ../../references/logging.md (--log-dir <path> and --short-log are also accepted). When invoked as part of an orchestrator (e.g. /inki:review), write into that run's existing directory instead of creating a new one.

Step 2: Apply the migrated outline-checker prompt

Read ../../references/prompts/outline-checker.md and use it as the system prompt. Compare the page's outline to the expected template at ../../references/templates/<template-name>.md.

Step 3: Report

Target: <path>
Expected template: <template name>
Outline issues:
- <heading missing | order wrong | extra section>: <details>