Wires documentation lint, link, and example checks into a repository CI gate.
npx skills add https://github.com/ocx-sh/grimoire-lore --skill docs-instrument-ocx-sh
Please help me install this Agent Skill. Skill: docs-instrument Source: https://github.com/ocx-sh/grimoire-lore/tree/main/skills/docs-instrument Command: npx skills add https://github.com/ocx-sh/grimoire-lore --skill docs-instrument-ocx-sh
doc_type and doc_tier comment declarations across the page tree using the correct comment carrier per generator (MkDocs, VitePress, mdBook, Docusaurus, Starlight, Sphinx). - Check wiring with a ratchet: Runs each check twice (error on the diff, warning on the whole tree), records warning baselines, and promotes checks to error only at zero standing violations. - Link and example verification: Configures strict builds or lychee for built output, a raw-markdown link pass, and a tested-example harness bound to pages by # doc: keys rather than mirrored paths. - Reader signals: Stands up zero-result search beacons, privacy-preserving analytics, time-to-first-working-result measurement, issue templates, and a Lighthouse score ratchet. - Use Case: A maintainer adopts a docs-quality rule set and asks to wire up docs CI; the Skill retrofits declarations, wires markdownlint and the shipped Python checks, proves each gate red once on a planted violation, and records the ratchet baselines. ## Quick Start Ask the assistant to wire up the docs-quality verification gate in this repository, starting with the doc_type declaration retrofit and the diff-scoped checks.High-intent search queries and answers about installing and using this skill.
Run each new check twice: at error severity on changed files only, and at warning severity across the whole tree. Record the whole-tree warning count as a ratchet baseline, and promote the check to error whole-tree only when standing violations reach zero.
Prefer the generator's own strict build, such as mkdocs build --strict, for built output. Where no strict mode exists, run lychee with --include-fragments against the build directory, and use a separate raw-markdown pass with a source root and exclusions for build-time-generated anchors.
Reach for the language's own doctest runner first, such as cargo test --doc, mdbook test, doctest, or deno test --doc. Where none fits, use a single-file subprocess harness that runs each example and asserts exit codes, binding tests to pages with a declared key rather than mirrored paths.
Yes, but the carrier differs by generator. Docusaurus requires a JSX comment like {/* doc_type: how-to */} because an HTML comment is a build error under MDX parsing, while MkDocs, VitePress, and mdBook use HTML comments and Sphinx uses % or .. comment forms.
Measured baselines show most existing pages fail new prose rules, so a whole-tree red gate blocks every open pull request on day one and gets switched off. Checks stay at warning until their false-positive rate is measured on the real corpus.
Do not use it to decide which pages to write or what the use-case tiers are; that planning belongs to a separate docs-plan skill. It also does not rewrite prose content, only retrofits declarations and wires verification configs.
pleaseaiRenders Markdown into static documentation sites with Vue-powered theming.
ssu96ldInsert documented components into Magnus site pages with gating rules.
musher-devDesign and audit documentation search systems with federated search and CMD+K patterns.
pmksharGenerate UTM-tagged URLs with validated parameters and platform-specific variants.