docs-check

Name: docs-check
Availability: InStock
Author: Tale

Run structural docs tests to validate parity, navigation, and content.

20|5|Updated Nov 30, 2025

Search Tags:#testing #structure #docs #frontmatter #parity #locales

Ready to run

npx skills add https://github.com/tale-project/tale --skill docs-check-tale-project

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs-check
Source: https://github.com/tale-project/tale/tree/main/.claude/skills/docs-check
Command: npx skills add https://github.com/tale-project/tale --skill docs-check-tale-project

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The structural docs test suite ensures the integrity of the docs graph by validating locale parity, structural correctness, and content quality, reducing merge risks and drift across docs/.

Core Features & Use Cases

Parity checks across locales to ensure translations mirror the source.
Structural validation of pages, navigation, and frontmatter.
Guidance on the fix-priority order before merging docs changes, with examples of common workflows.

Quick Start

Run the docs structural test suite from the repository root using bun run --filter @tale/docs test.

Frequently Asked Questions about docs-check

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

FAQPage Schema

How do I validate locale parity and structure across my docs corpus?▼

To validate locale parity and structure, run the structural docs test suite using bun run --filter @tale/docs test. It checks navigation, locale-tree, locale-outline, readme, and content-manifest to ensure translations mirror the source and prevent drift.

When do I need to run the docs structural test suite?▼

Run the docs structural test suite after renaming, moving, or deleting a page, editing docs/nav.json, adding a page in a new locale, changing a heading, or before a PR that touches docs to maintain structure and content parity.

What does the docs structural test suite check for?▼

The docs structural test suite checks for parity, navigation, locale-tree, locale-outline, readme, and content-manifest correctness. It reports which checks pass or fail and prescribes a fix-priority order using bunx and vitest-based tooling.

How do I fix failing docs parity and navigation checks?▼

To fix failing docs parity and navigation checks, follow the prescribed fix-priority order provided by the test suite output. Use the bunx and vitest-based tooling to resolve locale-tree, locale-outline, and content-manifest issues sequentially.

Do I need vitest to run the structural docs tests?▼

Yes, the structural docs test suite prescribes a fix-priority order using bunx and vitest-based tooling. You run the tests from the repository root via the bun run --filter @tale/docs test command to validate the docs graph.