validate-docs-rendered

A documentation checker that tests whether Markdown pages work when displayed, including Mermaid diagrams, internal links, YAML frontmatter, and code-block labels.

In plain words
What is it for?
Use it to check a documentation folder or file, group problems by severity, and report whether the rendered documentation passes.
Why use it?
It catches display and navigation problems that a normal writing review may miss, before readers encounter them.

Skill for Claude CodeCodex

Part of the cstk plugin — 21 skills, 7 commands, 7 agents shipped together

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/jotjunior/cstk/validate-docs-rendered
Any agent
npx skills add JotJunior/cstk --skill validate-docs-rendered
Clone the repo
git clone --depth 1 https://github.com/JotJunior/cstk

Made for: Claude Code, Codex.

Or install cstk, the plugin that ships this one along with the rest of its 21 skills, 7 commands, 7 agents.

Per session 67 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,830 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00067 $0.01830
Opus 5 $0.00034 $0.00915
Sonnet 5 $0.00013 $0.00366
Haiku 4.5 $0.00007 $0.00183

Measured 3d ago against content hash 2867675e81b3, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

validate-docs-rendered scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 3d ago.

The scan reads SKILL.md. This mod also ships 1 executable file (scripts/validate.sh), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

plugins/cstk/skills/validate-docs-rendered/SKILL.md · 209 lines

How it starts

The opening of the file, as written. The whole thing — 209 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Skill: Validar Renderizacao de Documentacao

Esta skill e uma skill de verificacao de produto (categoria 2 do artigo original). Ela nao valida se a documentacao esta escrita corretamente — isso e responsabilidade de validate-documentation e analyze. Ela valida se a documentacao realmente funciona quando renderizada em GitHub, GitLab, viewers Markdown, ou outros consumidores downstream.

O gap que ela fecha e o mesmo que o artigo cita: "a diferenca entre doc que passa no review e doc que renderiza corretamente em producao e onde moram os bugs mais caros".

Pre-requisitos

Obrigatorio: diretorio com documentacao Markdown existente (tipicamente docs/). Se argumento vazio, assume docs/ como default.

Proximos passos

  1. Corrigir issues reportados (diagramas invalidos, links quebrados)
  2. Re-rodar a skill para confirmar zero issues
  3. Considerar rodar como hook pre-commit para prevenir regressao

FLUXO DE EXECUCAO

1. LOCALIZAR        Descobrir escopo (arquivo unico ou arvore)
     |
2. VALIDAR          Rodar scripts de validacao em paralelo
     |
3. CLASSIFICAR      Agrupar findings por severidade
     |
4. REPORTAR         Output tabular + exit code

ETAPA 1: LOCALIZAR

Determinar o escopo a partir de $ARGUMENTS:

  • Caminho para arquivo (ex: docs/foo.md): validar apenas esse arquivo
  • Caminho para diretorio (ex: docs/02-requisitos-casos-uso/): validar recursivamente
  • Vazio: assumir docs/ na raiz do projeto

Se o caminho nao existe, abortar com mensagem clara.


ETAPA 2: VALIDAR

Usar o script scripts/validate.sh (mesmo diretorio desta skill). O script executa 4 validacoes em paralelo onde possivel:

2.1 Diagramas Mermaid

Verifica sintaxe de blocos ```mermaid:

  • Participantes declarados antes de uso em sequenceDiagram
  • Setas validas (->>, -->>, ->, -->, etc.)
  • Nos com IDs unicos em flowchart/graph
  • Fechamento correto de alt/else/end, loop/end, par/end
  • Sintaxe de erDiagram (relacionamentos, cardinalidade)

Read the full file on GitHub · 209 lines

Files

What ships with it

2 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 3d ago First seen · 209 lines · 67 tokens per session scan A 2867675e81b3

Subscribe to this mod's changes

validate-docs-rendered is a skill published in the GitHub repository JotJunior/cstk (22 stars, last pushed 4d ago), licensed MIT. It adds 67 tokens to every session and 1,830 once invoked, about $0.0003 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

brainstorming

You MUST use this before any creative work - creating features, building components, adding functionality, or modifying behavior. Explores user intent, requirements and design before implementation.

obra/superpowers · 37 tokens

auto-perf-optimize

Run agent-driven VS Code performance or memory investigations. Use when asked to launch Code OSS, automate a VS Code scenario, run the Chat memory smoke runner, capture renderer heap snapshots, take workflow screenshots, compare run summaries, or drive a repeatable scenario before heap-snapshot analysis.

microsoft/vscode · 62 tokens

chat-perf

Run chat perf benchmarks and memory leak checks against the local dev build or any published VS Code version. Use when investigating chat rendering regressions, validating perf-sensitive changes to chat UI, or checking for memory leaks in the chat response pipeline.

microsoft/vscode · 51 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens