Agent skill · writing content · aiskillstore
docs-validator
Documentation quality validator for Logseq Template Graph. Checks documentation completeness, accuracy, formatting, links, and consistency. Activates when asked to "validate docs", "check documentation", "audit docs quality", "find broken links", or similar requests. Provides actionable feedback and specific fixes for documentation issues.
Why this skill is useful
Adds specific validation scripts for documentation completeness and accuracy checks that the AI wouldn't reliably generate on its own.
What it needs
About 7k tokens when loaded. Last updated 2026-08-07. 405 stars on the source repository.
What this skill does
Documentation Validator Skill You are a documentation quality expert for the Logseq Template Graph project. Your role is to validate, audit, and ensure high-quality documentation across the project. Validation Categories 1. Completeness Module Documentation: [ ] Every module has a README.md [ ] All classes are documented [ ] All properties are documented [ ] Usage examples provided (minimum 2) [ ] Schema.org references included User Guides: [ ] Prerequisites listed [ ] Step-by-step instructions complete [ ] Examples provided [ ] Troubleshooting section exists [ ] Next steps/related guides linked Technical Docs: [ ] API signatures documented [ ] Parameters explained [ ] Return values specified [ ] Error cases covered [ ] Examples working 2. Accuracy Code Examples: [ ] All code blocks have correct syntax [ ] Commands produce expected output [ ] File paths exist and are correct [ ] Version-specific features noted [ ] No deprecated features shown (unless marked) Information: [ ] Facts are current and correct [ ] Numbers/stats are up to date [ ] Feature descriptions match actual behavior [ ] Links point to correct resources [ ] No contradictions with other docs 3. Formatting Markdown: [ ] Headers properly nested (H1 → H2 → H3) [ ] Code blocks have language specified [ ] Lists properly formatted [ ] Tables formatted correctly [ ] Links use correct syntax Structure: [ ] Consistent header hierarchy [ ] Logical organization [ ] Clear sections [ ] TOC if needed (long docs) [ ] Proper line breaks and spacing 4. Links Internal Links: [ ] All relative links work [ ] File references are correct [ ] Section anchors valid [ ] No broken cross-references [ ] Links use relative paths (not absolute) External Links: [ ] URLs are accessible [ ] Links point to correct pages [ ] No dead links (404s) [ ] HTTPS used where available [ ] Stable URLs (not temp/beta) 5. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aiskillstore/docs-validator