[jonasthim]

Summary

This PR adds three things: a docs/ site, a root README that works on its own, and a step-by-step guide to building a mod with a tested example.

Changes

• docs/ (plain Markdown that renders on GitHub; GitHub Pages can serve it from /docs via _config.yml):
  • index.md
  • getting-started.md: install, a sourced env file, first checks, update and uninstall, and moving from the old repos.
  • truenas.md, proxmox.md, unifi.md: per plugin, where to create credentials (read-only first), the variables, commands and example prompts, the safety rules, and troubleshooting.
  • safety.md: the shared model, with a per-plugin comparison table covering gates, previews, what runs without asking, redaction, TLS defaults and read-only credentials.
  • mods.md: the hook model, layout, a worked example, develop/check/publish steps, and limits.
• docs/examples/homelab-guard: the guide's worked example.
  • It is a tool.check hook on Bash. It turns an allow into an ask for tn.py … --confirm, unifi.py … --yes and pve-api.sh delete, never loosens a deny, and fails safe to ask.
  • It has 4 tests. The code in docs/mods.md is generated from these files.
  • CI runs claude plugin validate and claude plugin test on it.
  • It is not listed in the marketplace, so no mod ships yet.
• Root README.md: quick start, credentials at a glance, example prompts per plugin, a safety summary, update/uninstall, and a docs index.
• mods/README.md: now points to the guide and keeps the conventions.
• plugins/proxmox/README.md: token creation is no longer listed as a free action, finishing the review fix from Consolidate truenas, proxmox and unifi plugins into one marketplace #1. A CHANGELOG line records it.

Testing

• Relative link check over every tracked *.md: 0 broken.
• claude plugin validate . passes.
• Example mod: claude plugin validate passes, claude plugin test gives 4 pass, and tsc (strict) is clean.
• Plugin suites:
  • truenas: OK
  • proxmox: 312 passed, 0 failed
  • unifi: 15 passed

After merge

To publish the site, enable Pages under Settings → Pages: branch main, folder /docs.

🤖 Generated with Claude Code

https://claude.ai/code/session_01CE5mahfuiAeTFLfTQP2dbR

---

Generated by Claude Code

[Copilot]

Copilot review overview

🟡 Changes recommended

The guard misses multiline confirmed commands, and several published Pages links are broken.

Review effort: Balanced
Findings: 2 · 1 · 5

Open (8)

• Match multiline destructive commands · New
• Update example patterns for multiline commands · New
• Document transport-specific API requirements · New
• Use repository URL for CONTRIBUTING.md · New
• Use repository URL for full reference · New
• Link CONTRIBUTING.md to repository · New
• Link to repository copy outside docs · New
• Use repository URL for full reference · New

What changed in this PR

Adds a GitHub Pages-ready documentation site, expands standalone onboarding, and introduces a tested function-hook mod guide.

Changes:

• Adds installation, plugin, safety, and troubleshooting documentation.
• Adds the tested homelab-guard worked example and CI validation.
• Corrects Proxmox token-creation guidance.

File	Description
README.md	Expands root onboarding and documentation links.
plugins/​proxmox/​README.md	Corrects token-creation safety guidance.
plugins/​proxmox/​CHANGELOG.md	Records the documentation correction.
mods/​README.md	Redirects readers to the expanded mod guide.
docs/​index.md	Adds the documentation landing page.
docs/​getting-started.md	Documents installation and configuration.
docs/​truenas.md	Adds TrueNAS setup and safety guidance.
docs/​proxmox.md	Adds Proxmox setup and command guidance.
docs/​unifi.md	Adds UniFi setup and safety guidance.
docs/​safety.md	Compares plugin safety models.
docs/​mods.md	Adds the function-hook development guide.
docs/​_config.yml	Configures GitHub Pages.
docs/​examples/​homelab-guard/​.claude-plugin/​plugin.json	Defines the example plugin.
docs/​examples/​homelab-guard/​hooks/​hooks.json	Registers its hook module.
docs/​examples/​homelab-guard/​hooks/​register.ts	Implements command permission checks.
docs/​examples/​homelab-guard/​hooks/​guard.test.ts	Tests guard behavior.
.github/​workflows/​ci.yml	Validates and tests the example.

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.