harness-docs

Community

Auto-generate and sync project documentation

Authorwoink
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Generates a complete, structured documentation site from repository sources and skill metadata so teams don't have to write and keep reference pages, script docs, and changelogs manually. It performs cold reads of SKILL.md files, scripts, and README content and produces a coherent Docusaurus site plus a machine-readable generation report, enabling reproducible, file-based handoffs that survive context resets.

Core Features & Use Cases

  • Full-site scaffolding: On first run, scaffold a Docusaurus 3.x site with landing pages, per-skill reference pages, script docs, and blog changelog entries from git history.
  • Incremental regeneration: On re-runs, detect stale pages using last_generated frontmatter and only regenerate pages whose sources changed, minimizing churn.
  • Auditability and CI integration: Emit .harness/DOCS_REPORT.md with coverage, gaps, and git SHA, then commit changes to trigger documentation build workflows.
  • Robust error handling: Produce stub pages and detailed gap reports when SKILL.md frontmatter is malformed or sources are missing.

Quick Start

Generate a complete Docusaurus docs-site from the repository and write a .harness/DOCS_REPORT.md summarizing what was generated, skipped, and any gaps found.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: harness-docs
Download link: https://github.com/woink/harness-skills-plugin/archive/main.zip#harness-docs

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.