home / skills / falkicon / mechanic / k-docs

k-docs skill

safe

This skill provides a concise index of Mechanic documentation with summaries and links to help you locate topics quickly.

npx playbooks add skill falkicon/mechanic --skill k-docs

Review the files below or copy the command above to add this skill to your agents.

Files (1)

SKILL.md

3.1 KB

---
name: k-docs
description: >
  Index of Mechanic documentation with summaries and links. Load this
  to understand what documentation exists and where to find detailed
  information on specific topics.
  Triggers: docs, documentation, reference, guide, help.
---

# Documentation Index

Quick reference to all Mechanic documentation.

## Core Documentation

| Document | Path | Summary |
|----------|------|---------|
| **AGENTS.md** | `AGENTS.md` | Agent guidance, project structure, AFD standards |
| **CLAUDE.md** | `CLAUDE.md` | Quick reference for AI assistants |
| **README.md** | `README.md` | Project overview and getting started |
| **CHANGELOG.md** | `CHANGELOG.md` | Version history and release notes |

## Integration Guides

Located in `docs/integration/`:

| Document | Summary |
|----------|---------|
| **mechaniclib.md** | How to integrate addons with MechanicLib |
| **testing.md** | Sandbox, Busted, and in-game testing strategies |
| **console.md** | Structured logging via MechanicLib:Print |
| **errors.md** | BugGrabber integration and error tracking |
| **performance.md** | Profiling and performance baselines |
| **release.md** | Release workflow and changelog format |
| **inspect.md** | Frame inspector usage |
| **troubleshooting.md** | Common issues and solutions |

## Architecture Documentation

| Document | Path | Summary |
|----------|------|---------|
| **addon-architecture.md** | `docs/addon-architecture.md` | Core/Bridge/View layer pattern |
| **addon-integration.md** | `docs/addon-integration.md` | How to integrate with Mechanic |
| **cli-reference.md** | `docs/cli-reference.md` | Full CLI command reference |

## .claude System Documentation

| Document | Path | Summary |
|----------|------|---------|
| **AGENTS.md** | `.claude/AGENTS.md` | Command/skill taxonomy (c-/s-/k-) |

## Skill References

Each skill has its own `references/` folder with deep-dive content:

| Skill | Key References |
|-------|---------------|
| **s-debug** | `error-patterns.md`, `debugging-strategies.md` |
| **s-develop** | `event-patterns.md`, `frame-engineering.md`, `saved-variables.md`, `combat-lockdown.md`, `api-patterns.md` |
| **s-test** | `busted-patterns.md`, `wow-mocking.md` |
| **s-research** | `api-research.md`, `blizzard-ui.md`, `ace3-patterns.md` |
| **k-mechanic** | `cli-commands.md`, `afd-commands.md`, `ingame-modules.md`, `mechaniclib.md`, `dashboard.md` |

## MCP Tool Discovery

Use these MCP tools to explore available functionality:

```
env.status()              # Environment and paths
docs.generate()           # Generate full CLI reference
api.stats()               # API database statistics
fencore.catalog()         # All FenCore functions
```

## Quick Links by Topic

| Topic | Where to Look |
|-------|---------------|
| Getting started | `README.md`, `docs/addon-integration.md` |
| Debugging issues | `s-debug` skill, `docs/integration/troubleshooting.md` |
| Writing tests | `s-test` skill, `docs/integration/testing.md` |
| Releasing addons | `s-release` skill, `docs/integration/release.md` |
| WoW API research | `s-research` skill, `api.search` MCP tool |
| Architecture decisions | `docs/addon-architecture.md` |

Overview

This skill provides a browsable index of Mechanic documentation with short summaries and direct links to detailed guides. It helps World of Warcraft addon developers quickly locate integration notes, architecture papers, testing guidance, and skill-specific references. Load this to understand what docs exist and where to find in-depth information on specific topics.

How this skill works

The skill catalogs core docs, integration guides, architecture notes, .claude system files, and per-skill reference folders. It maps common developer needs (getting started, debugging, testing, release) to the exact file or skill reference and points to MCP tools for interactive discovery. Use the index to jump to targeted content rather than searching the codebase manually.

When to use it

You need a quick pointer to the right Mechanic document for a specific task.
Onboarding new contributors who must find getting-started and architecture docs.
Preparing a release and wanting the release workflow and changelog format.
Debugging or testing and needing tool-specific integration or troubleshooting notes.
Researching API behavior and looking for skill-specific deep dives.

Best practices

Start with README.md and addon-integration.md for context before diving deep.
Use skill reference folders (references/) for targeted patterns and examples.
Leverage the MCP discovery commands (env.status(), docs.generate(), api.stats()) for interactive exploration.
Follow the documented AFD and CLI conventions in k-mechanic and .claude AGENTS.md for consistent tooling.
Cross-reference troubleshooting, console, and errors guides when tracking runtime problems.

Example use cases

Find the integration steps to wire MechanicLib into an addon via docs/integration/mechaniclib.md.
Locate profiling and performance baseline guidance in docs/integration/performance.md before optimizing code.
Retrieve testing patterns and wow-mocking examples from s-test references and docs/integration/testing.md.
Identify where debugging strategies and error-patterns live under s-debug references when triaging crashes.
Access CLI command details and AFD workflows in k-mechanic references and docs/cli-reference.md when scripting releases.

FAQ

How do I find where a specific topic (like frame inspection) is documented?

Use the Quick Links by Topic section or search integration docs; frame inspector usage is in docs/integration/inspect.md.

Which docs should I read first as a new contributor?

Start with README.md, docs/addon-integration.md, and AGENTS.md to understand project scope, integration points, and agent standards.