Docs

Documentation workflows for Tenzir projects. Guides you through the Diátaxis framework for structuring content, and provides commands and agents for writing, reviewing, and publishing documentation.

Features

• 📚 Authoring Skill: Guidance on the Diátaxis framework, section selection, and Tenzir docs conventions
• ✍️ Write Command: Interactive workflow for documenting changes
• 👀 Review Command: Check completeness and style of documentation changes
• 🔀 PR Command: Create documentation PRs with cross-referencing to parent project PRs
• 🤖 Writer Subagent: Autonomous agent that writes, reviews, and publishes documentation
• 🔍 Reader Subagent: Answers questions by navigating the live documentation

Installation

Interactive

Use the plugin manager UI in Claude Code.

1. Run /plugin in Claude Code Enter
2. Go to Marketplaces Tab
3. Select + Add Marketplace Enter
4. Type tenzir/claude-plugins Enter
5. Install docs from the plugin list

Shell

Run the CLI command with your preferred scope.

# Install to user scope (default)
claude plugin install docs@tenzir

# Install to project scope (shared with team)
claude plugin install docs@tenzir --scope project

# Install to local scope (gitignored)
claude plugin install docs@tenzir --scope local

Settings

Add the marketplace and plugin to your settings file.

.claude/settings.json

{
  "extraKnownMarketplaces": {
    "tenzir": {
      "source": {
        "source": "github",
        "repo": "tenzir/claude-plugins"
      }
    }
  },
  "enabledPlugins": {
    "docs@tenzir": true
  }
}

Capabilities

Type	Name	Description
Skill	authoring	Author documentation for Tenzir projects. Use when creating or updating tutorials, guides, explanations, reference, or integrations.
Command	/docs:pr	Create a pull request for documentation changes in .docs/
Command	/docs:review	Review documentation changes for completeness and style
Command	/docs:write	Write/update documentation for user-facing changes and new features
Agent	docs:reader	Answer questions about Tenzir documentation. Use when the user asks about TQL, operators, functions, platform features, or how to use Tenzir.
Agent	docs:writer	Write, review, and publish documentation. Creates a PR for tenzir/docs.
Hook	PreToolUse	Triggers on Read, Edit, Write

Usage

Writing documentation

Document your recent changes:

/docs:write

The command analyzes uncommitted changes (or the last commit) and creates documentation in the appropriate Diataxis section.

Document a specific topic:

/docs:write the new batch operator

Changelog

View the release history and recent changes.

View on GitHub

Browse the plugin source code and documentation.