sparkengine-docs-wiki-and-generated-truth

Regenerates and validates SparkEngine wiki, README, and generated documentation against source code.

31|3|Updated Jul 26, 2025
One-click install
npx skills add https://github.com/Krilliac/SparkEngine --skill sparkengine-docs-wiki-and-generated-truth-krilliac
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sparkengine-docs-wiki-and-generated-truth
Source: https://github.com/Krilliac/SparkEngine/tree/main/.claude/skills/sparkengine-docs-wiki-and-generated-truth
Command: npx skills add https://github.com/Krilliac/SparkEngine --skill sparkengine-docs-wiki-and-generated-truth-krilliac

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documentation drift is inevitable in a fast-moving C++ game engine: README counts go stale, wiki pages describe deleted classes, and generated API docs diverge from code. This Skill provides the complete pipeline for keeping SparkEngine's five documentation layers (handwritten prose, generated AUTO regions, validators, CI enforcement, and publication) consistent with the actual source tree. ## Core Features & Use Cases - Layer-aware drift repair: Identifies whether a wrong statement lives in handwritten prose, generated AUTO regions, or the readiness contract, then applies the correct fix (edit prose vs. re-run a generator) instead of editing generated output that will be overwritten. - Regeneration and validation commands: Verified invocations for docs/update-all-docs.sh, docs/sync-wiki.sh, API doc generation, symbol indexes, README badge counts, and validators like check-wiki-nav.sh, validate-prompts.sh, and tools/site-data/validate.py. - Readiness handoff governance: Explains the site-data contract vocabularies (implementation, verification, support, release states) and why ENGINE_READINESS_HANDOFF.md must be regenerated, never hand-edited. - Use Case: A CI run fails with "sync-wiki check exited 1". Use this Skill to identify the stale AUTO region, run docs/sync-wiki.sh sync, verify with the check mode, and confirm the publish-wiki validate job will pass. ## Quick Start Ask the assistant to check whether the SparkEngine wiki and README counts are stale and regenerate any out-of-date generated documentation sections.

Frequently Asked Questions about sparkengine-docs-wiki-and-generated-truth

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I fix stale wiki documentation in SparkEngine?

First identify the layer: if the wrong text sits inside AUTO markers, wiki/reference pages, or Codebase-Statistics, re-run the matching generator such as docs/sync-wiki.sh sync. If it is handwritten prose, edit the file directly and then run the relevant check script.

Why does the publish-wiki CI validate job fail?

The validate job fails when a wiki page is missing from wiki/_Sidebar.md, AUTO regions are stale, or prompt files reference deleted paths. Reproduce locally with bash tools/check-wiki-nav.sh, bash docs/sync-wiki.sh check, and python3 tools/publish-wiki.py --check.

Can I edit ENGINE_READINESS_HANDOFF.md directly?

No. The handoff is generated by tools/site-data/render_handoff.py from the docs/site JSON contract, and CI runs it with --check to fail on divergence. Change the contract JSON instead, then regenerate the handoff.

Why does sync-wiki check report success but CI still fails?

Piping the check to tail fabricates exit code 0 because the pipeline reports tail's status. Run bash docs/sync-wiki.sh check; echo $? or use ${PIPESTATUS[0]} to see the real exit code, which is 1 on a stale tree.

When should I not use this documentation skill?

Do not use it for release ship decisions (use the change-control skill), CMake or CI build fixes (use the build-ci skill), incident root-cause reconstruction (use failure-archaeology), or writing Doxygen comments for new features, which belongs to that feature's subsystem skill.