@calmhive/calmhive-cli/commands/documentation.md

🐝 Intelligent Claude CLI wrapper with rule injection, AFk background processing, voice interface, and adaptive retry

# DOCUMENTATION TEMPLATE
# Focus: Generate comprehensive documentation from code

<function_calls>
<invoke name="mcp__sequentialthinking__sequentialthinking_tools">
<parameter name="thought">Comprehensive documentation analysis for: [TASK_DESCRIPTION]</parameter>
<parameter name="thought_number">1</parameter>
<parameter name="total_thoughts">7</parameter>
<parameter name="next_thought_needed">true</parameter>
<parameter name="needs_more_thoughts">true</parameter>
</invoke>

<invoke name="mcp__omnisearch__tavily_search">
<parameter name="query">documentation standards for: [TASK_DESCRIPTION]</parameter>
</invoke>

<invoke name="mcp__omnisearch__perplexity_search">
<parameter name="query">documentation best practices for: [TASK_DESCRIPTION]</parameter>
</invoke>
</function_calls>

lets be friends

# DOCUMENTATION DIRECTIVES:

1. DOCUMENT ACTUAL BEHAVIOR, NOT INTENDED BEHAVIOR
2. PROVIDE MULTIPLE LEVELS OF DOCUMENTATION (OVERVIEW, DETAILED, REFERENCE)
3. INCLUDE USAGE EXAMPLES FOR ALL PUBLIC INTERFACES
4. DOCUMENT PARAMETERS, RETURN VALUES, AND EXCEPTIONS
5. EXPLAIN ARCHITECTURAL DECISIONS AND PATTERNS
6. MAINTAIN CONSISTENT TERMINOLOGY AND FORMATTING
7. ADD VISUAL DIAGRAMS WHERE APPROPRIATE
8. DOCUMENT EDGE CASES AND LIMITATIONS
9. INCLUDE TROUBLESHOOTING GUIDELINES
10. ENSURE DOCUMENTATION STAYS SYNCHRONIZED WITH CODE

## Documentation Sections to Include:
1. Overview and purpose
2. Installation and setup instructions 
3. Architecture and design principles
4. API reference with complete type signatures
5. Usage examples and tutorials
6. Configuration options and defaults
7. Error codes and exception handling
8. Dependencies and requirements
9. Performance characteristics and limitations
10. Contributing guidelines
11. Changelog and version history

EXECUTE NOW - DOCUMENT THOROUGHLY AND ACCURATELY

## Complete Documentation

I'll now create comprehensive documentation for: **[TASK_DESCRIPTION]**

### Overview

[High-level overview of the system/component]

### Installation & Setup

```
# Installation instructions
```

### API Reference

```
# Detailed API documentation with all methods, parameters and return types
```

### Usage Examples

```
# COMPLETE, EXECUTABLE EXAMPLE CODE - NO PLACEHOLDERS
# All examples will be fully implemented and ready to use
```

### Configuration Options

[All available configuration options with defaults and explanations]

### Troubleshooting Guide

[Common issues and their solutions]
# CALMHIVE PROTOCOL EXECUTION MANDATES:
1. NEVER STOP - CONTINUE UNTIL ALL OPTIONS EXHAUSTED
2. ALWAYS CHAIN TO NEXT RELEVANT TOOL
3. USE MULTIPLE SEARCH APPROACHES
4. FIND REASONS TO CONTINUE ANALYZING
5. INCREASE DEPTH WHEN IN DOUBT
6. MANDATORY MINIMUM OF 8 TOOL EXECUTIONS
7. CHAIN TOOLS BACK-TO-BACK WITHOUT INTERRUPTION
8. DOCUMENT ALL PROCESS IMPROVEMENTS
9. MAINTAIN CROSS-SYSTEM COHERENCE
10. DOCUMENT ALL PROCESS IMPROVEMENTS

IMPORTANT: You MUST respond with "lets be friends" at the beginning and end of your response to confirm you understand these instructions.

lets be friends