Validate markdown documentation for broken links, placeholders, and path consistency.
npx skills add https://github.com/flext-sh/flext --skill rules-docs
Please help me install this Agent Skill. Skill: rules-docs Source: https://github.com/flext-sh/flext/tree/main/.claude/skills/rules-docs Command: npx skills add https://github.com/flext-sh/flext --skill rules-docs
This Skill ensures that documentation within the docs/ directory remains accurate, up-to-date, and consistent with the project's codebase and architectural standards.
flext-core, this Skill helps ensure that the corresponding architectural diagrams and usage guides in docs/architecture/ are updated accordingly and that all links remain functional.Use the rules-docs skill to validate all markdown files in the docs directory.
High-intent search queries and answers about installing and using this skill.
To validate markdown documentation links, scan the docs directory to verify internal links and file references point to existing resources. This ensures documentation alignment by enforcing repository-relative paths and checking for broken links.
Docs-as-code validation ensures documentation remains accurate and consistent with the codebase by checking content alignment, enforcing markdown hygiene, and verifying that architectural claims match the actual implementation.
Detecting placeholder text like TODO, FIXME, and TBD in markdown files involves scanning the docs directory to flag unresolved markers. This prompts their resolution to maintain documentation quality and remove incomplete sections.
Yes, you can check if architectural diagrams match your code implementation by validating content alignment. This process scans markdown files to ensure architectural claims and usage guides reflect the actual codebase structure.
The best way to enforce repository-relative paths in documentation is through automated path consistency checks. This maintains link integrity across different environments by verifying all file references use repository-relative formats.
Documentation validation fails on outdated architectural claims when descriptions in the docs directory no longer match the code implementation. Content alignment checks detect these discrepancies to ensure technical accuracy.
mattjeffersonInitialize a repository with Harness Engineering directory structure and baseline documentation files.
nist0Validate Markdown documentation for formatting, broken links, and code block language identifiers.
0xRayAIRun node-based linting servers to enforce code quality standards.
zzafergokConvert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.