Skip to main content

ferrox-docs-update

You want project documentation written or refreshed, checked against the actual code

Source facts

Repository
FerroxLabs/ferrox-factory
Last source activity
July 31, 2026 at 00:15
Detected SKILL.md language
English
Stars
23
Forks
8

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

Showing SKILL.md

SKILL.md
Source instructions · Read-only preview
name
ferrox-docs-update
description
You want project documentation written or refreshed, checked against the actual code
argument-hint
[--force] [--verify-only]
allowed-tools
["Read","Write","Edit","Bash","Glob","Grep","Agent","AskUserQuestion"]
<objective> Generate and update up to 9 documentation files for the current project. Each doc type is written by a ferrox-doc-writer subagent that explores the codebase directly — no hallucinated paths, phantom endpoints, or stale signatures. Flag handling rule: - The optional flags documented below are available behaviors, not implied active behaviors - A flag is active only when its literal token appears in `$ARGUMENTS` - If a documented flag is absent from `$ARGUMENTS`, treat it as inactive - `--force`: skip preservation prompts, regenerate all docs regardless of existing content or Ferrox markers - `--verify-only`: check existing docs for accuracy against codebase, no generation (full verification requires Phase 4 verifier) - If `--force` and `--verify-only` both appear in `$ARGUMENTS`, `--force` takes precedence </objective> <execution_context> @~/.claude/ferrox-core/workflows/docs-update.md </execution_context> <context> Arguments: $ARGUMENTS **Available optional flags (documentation only — not automatically active):** - `--force` — Regenerate all docs. Overwrites hand-written and Ferrox docs alike. No preservation prompts. - `--verify-only` — Check existing docs for accuracy against the codebase. No files are written. Reports VERIFY marker count. Full codebase fact-checking requires the ferrox-doc-verifier agent (Phase 4). **Active flags must be derived from `$ARGUMENTS`:** - `--force` is active only if the literal `--force` token is present in `$ARGUMENTS` - `--verify-only` is active only if the literal `--verify-only` token is present in `$ARGUMENTS` - If neither token appears, run the standard full-phase generation flow - Do not infer that a flag is active just because it is documented in this prompt </context> <process> Execute end-to-end. Preserve all workflow gates (preservation_check, flag handling, wave execution, monorepo dispatch, commit, reporting). </process>
View on GitHub