hotplex-docs-patrol

Map code changes to affected HotPlex docs and apply targeted updates.

47|15|Updated Mar 30, 2026
One-click install
npx skills add https://github.com/hrygo/hotplex --skill hotplex-docs-patrol
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: hotplex-docs-patrol
Source: https://github.com/hrygo/hotplex/tree/main/.agents/skills/hotplex-docs-patrol
Command: npx skills add https://github.com/hrygo/hotplex --skill hotplex-docs-patrol

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

It prevents HotPlex documentation from going stale by detecting code changes and updating only the documentation that is truly affected, instead of doing mechanical checklist reviews.

Core Features & Use Cases

  • Change-aware doc maintenance: Tracks a rolling baseline commit and analyzes new commits by intent (feature additions, breaking behavior changes, refactors, bug fixes).
  • Code→docs impact mapping: Uses the documentation registry to determine which docs are likely impacted, then verifies the content against current code and documentation.
  • Health-checked updates: Builds the docs with make docs-build to ensure links and documentation compile successfully before finalizing.
  • Precise remediation: Fixes outdated content, fills missing details for new capabilities/configs, removes redundant descriptions, and repairs broken cross-references.

Quick Start

Run the docs patrol skill when users ask about daily docs status or after releases and major PR merges, so it can update the correct HotPlex documentation based on since-last-run code changes.

Frequently Asked Questions about hotplex-docs-patrol

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

FAQPage Schema
How do I keep documentation accurate after code changes without manual checklist reviews?

Documentation maintenance after code changes is automated by mapping change semantics to affected docs via a registry, applying targeted updates instead of manual checklists. It analyzes new commits by intent to verify content against current code.

How does mapping code to docs work for detecting broken links and outdated content?

Code to docs mapping reads the doc-registry to identify impacted documentation, then verifies content against current code. It tracks a rolling baseline commit to detect feature additions, breaking changes, refactors, and bug fixes for precise remediation.

When should I run a docs patrol check during the development lifecycle?

Run a docs patrol check during release reviews, post-major-PR checks, and for ongoing daily docs status queries. It focuses on documentation reachable from index.md via the BFS boundary produced by the build and discovery tool.

Does the documentation maintenance workflow require a git diff analysis baseline?

Yes, git diff analysis requires a baseline-driven git change window to identify since-last-run code changes. The skill updates the .docs-patrol-baseline file at the end of each run to maintain a rolling baseline for future change detection.

How do I validate docs governance and ensure links compile before finalizing updates?

Validate docs governance and ensure links compile by running make docs-build to verify documentation builds successfully before finalizing. This health check prevents broken cross-references and ensures updated content compiles without errors.

What are the limitations of using an automated code to docs mapping tool?

Automated code to docs mapping is limited to processing only docs reachable from index.md via the BFS boundary produced by the build tool. Documentation outside this discovery boundary will not be analyzed or updated during the patrol.