code-sample-checker

Planned: verify that code samples in documentation are syntactically valid, use current APIs and package versions, are consistent across languages, and run where possible. Use when a writer asks to test, validate, or update code snippets, examples, or quickstarts in docs. Scaffold only; not ready for use.

Jump to install Review files

Repository: GitbookIO/docs-skills
Last source activity: October 27, 2026 at 11:55
Detected SKILL.md language: English
Stars: 0
Forks: 0

Install options

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

Install with an AI assistant

Copy this prompt into the AI assistant you're using.

Follow https://skillsmp.com/skill-install/prompt.md to install only the Agent Skill at https://github.com/GitbookIO/docs-skills/tree/main/skills/code-sample-checker.

A direct command skips the review prompt. Inspect the source before running it.

npx skills add https://github.com/GitbookIO/docs-skills --skill code-sample-checker

The command stays on one line. Scroll horizontally to inspect it before copying.

Prefer a local copy? Download the files currently available to SkillsMP.

Review the source files

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

SKILL.md

Source instructions · Read-only preview

name: code-sample-checker
description: Planned: verify that code samples in documentation are syntactically valid, use current APIs and package versions, are consistent across languages, and run where possible. Use when a writer asks to test, validate, or update code snippets, examples, or quickstarts in docs. Scaffold only; not ready for use.

# Code sample checker Find and check every code sample in a docs set so that copied examples work for readers and agents. ## Status Scaffold only — not ready for use. ## Planned - Extract fenced code blocks with their language tags and surrounding context - Lint or parse each sample for its language and flag missing language tags - Flag deprecated APIs, outdated package versions, and placeholder values that are not explained - Run safe, self-contained samples in a sandbox when the user allows it - Check that equivalent samples in different languages do the same thing

View on GitHub

Back to search Back to installation

accessibility-checker

Planned: review documentation for content accessibility issues, including missing or poor image alt text, skipped heading levels, non-descriptive link text, color- or position-only instructions, inaccessible tables, and unexplained abbreviations. Use when a writer asks to check docs for accessibility, alt text, or inclusive and readable content. Scaffold only; not ready for use.

2026-10-27

ai-readiness

Check or fix documentation pages for AI readability, so AI assistants, Ask AI, RAG pipelines, and other LLM retrieval systems can retrieve, chunk, and quote them accurately. Use when a writer asks whether docs are AI-ready or LLM-ready, how pages will chunk for retrieval, or to audit or fix pages for AI assistants. Runs checks A-1 to A-10 (description, opening paragraph, headings, empty sections, section length, tables, values in images, leading pronouns, link text, SUMMARY.md listing) and reports a pass or fail per page with the offending line.

2026-10-27

broken-link-checker

Planned: find broken, redirected, and fragile links in a documentation repo or published docs site, including relative links, heading anchors, images, and external URLs, and propose fixes. Use when a writer asks to check links, find 404s, fix dead links, or audit links before a release or migration. Scaffold only; not ready for use.

2026-10-27

View all from this repository

code-sample-checker

Source facts

Install options

Install with an AI assistant

Review the source files

More from this repository

Install with an AI assistant

More from this repository