docs-lint

Detect broken links, invalid frontmatter paths, and stale anchors in JellyRock documentation.

37|2|Updated Jun 28, 2025
One-click install
npx skills add https://github.com/jellyrock/jellyrock --skill docs-lint-jellyrock
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-lint
Source: https://github.com/jellyrock/jellyrock/tree/main/.claude/skills/docs-lint
Command: npx skills add https://github.com/jellyrock/jellyrock --skill docs-lint-jellyrock

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

JellyRock's documentation can accumulate broken markdown links, invalid related-files frontmatter paths, stale tech-debt anchor references, and outdated architecture docs that haven't been reviewed in months. Manually catching these issues is time-consuming and error-prone, leading to broken references for users and blocked PRs during CI checks.

Core Features & Use Cases

  • Reference Integrity Checks: Runs automated validation to catch broken related-files paths, inline markdown links, and stale tech-debt anchors across all JellyRock documentation.
  • Stale Doc Detection: Identifies architecture docs whose last-reviewed date is past the 90-day threshold, flagging ones that need updating if their related file territory was modified in a PR.
  • Structured Fix Suggestions: Categorizes all found issues and provides actionable, context-aware fix proposals for each error type, eliminating guesswork for contributors.
  • Use Case: When preparing a PR that modifies JellyRock's docs or architecture files, run this skill to catch all documentation issues before pushing, avoiding CI failures and reducing review back-and-forth.

Quick Start

Use the docs-lint skill to run all JellyRock docs governance checks and get a categorized list of fixes for any broken links, stale references, or outdated docs found.

Frequently Asked Questions about docs-lint

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

FAQPage Schema
How do I catch broken markdown links and invalid related-files paths in my docs before pushing?

You can catch broken markdown links and invalid related-files paths by running automated docs validation that checks reference integrity across your documentation directory before committing changes. This prevents CI failures and broken user references.

What is the best way to detect stale tech-debt anchor references in documentation?

The best way to detect stale tech-debt anchor references is to run an automated validator that parses documentation files and flags anchors that no longer resolve. This categorizes issues into actionable fix suggestions without manual error triage.

How do I identify architecture docs that haven't been reviewed in over 90 days?

To identify architecture docs needing review, run stale doc detection which flags files whose last-reviewed date exceeds the 90-day threshold. It prioritizes outdated docs if their related file territory was modified in a PR.

Can I automate documentation governance checks for a PR review?

Yes, you can automate documentation governance for PR reviews by running a pre-push hook validation or one-shot audit. It consumes validator JSON output to generate categorized, context-aware fix proposals for contributors.

Why does my CI check fail when I modify architecture files without updating related docs?

Your CI check fails because modifying architecture files without updating related documentation triggers broken related-files paths and stale tech-debt anchors. Run a documentation linting check to catch these issues before pushing.

Does the docs validation process require manual error triage to fix broken references?

No, the docs validation process does not require manual error triage. It consumes validator JSON output and human-readable stale doc reports to generate categorized, actionable fix suggestions for each broken reference automatically.