k-docs_skill

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.