npm - claude-code-templates - Versions diffs - 1.21.5 → 1.21.6 - Mend

claude-code-templates 1.21.5 → 1.21.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (498) hide show

package/components/commands/documentation/doc-api.md ADDED Viewed

@@ -0,0 +1,242 @@
+---
+allowed-tools: Read, Write, Edit, Bash
+argument-hint: [api-type] | --openapi | --graphql | --rest | --grpc | --interactive
+description: Generate comprehensive API documentation from code with interactive examples and testing capabilities
+model: sonnet
+---
+# API Documentation Generator
+Generate API documentation from code: $ARGUMENTS
+## Current API Context
+- API endpoints: !`find . -name "*route*" -o -name "*controller*" -o -name "*api*" | head -5`
+- API specs: !`find . -name "*openapi*" -o -name "*swagger*" -o -name "*.graphql" | head -3`
+- Server framework: @package.json or detect from imports
+- Existing docs: @docs/api/ or @api-docs/ (if exists)
+- Test files: !`find . -name "*test*" -path "*/api/*" | head -3`
+## Task
+Generate comprehensive API documentation with interactive features: $ARGUMENTS
+1. **Code Analysis and Discovery**
+   - Scan the codebase for API endpoints, routes, and handlers
+   - Identify REST APIs, GraphQL schemas, and RPC services
+   - Map out controller classes, route definitions, and middleware
+   - Discover request/response models and data structures
+2. **Documentation Tool Selection**
+   - Choose appropriate documentation tools based on stack:
+     - **OpenAPI/Swagger**: REST APIs with interactive documentation
+     - **GraphQL**: GraphiQL, GraphQL Playground, or Apollo Studio
+     - **Postman**: API collections and documentation
+     - **Insomnia**: API design and documentation
+     - **Redoc**: Alternative OpenAPI renderer
+     - **API Blueprint**: Markdown-based API documentation
+3. **API Specification Generation**
+   **For REST APIs with OpenAPI:**
+   ```yaml
+   openapi: 3.0.0
+   info:
+     title: $ARGUMENTS API
+     version: 1.0.0
+     description: Comprehensive API for $ARGUMENTS
+   servers:
+     - url: https://api.example.com/v1
+   paths:
+     /users:
+       get:
+         summary: List users
+         parameters:
+           - name: page
+             in: query
+             schema:
+               type: integer
+         responses:
+           '200':
+             description: Successful response
+             content:
+               application/json:
+                 schema:
+                   type: array
+                   items:
+                     $ref: '#/components/schemas/User'
+   components:
+     schemas:
+       User:
+         type: object
+         properties:
+           id:
+             type: integer
+           name:
+             type: string
+           email:
+             type: string
+   ```
+4. **Endpoint Documentation**
+   - Document all HTTP methods (GET, POST, PUT, DELETE, PATCH)
+   - Specify request parameters (path, query, header, body)
+   - Define response schemas and status codes
+   - Include error responses and error codes
+   - Document authentication and authorization requirements
+5. **Request/Response Examples**
+   - Provide realistic request examples for each endpoint
+   - Include sample response data with proper formatting
+   - Show different response scenarios (success, error, edge cases)
+   - Document content types and encoding
+6. **Authentication Documentation**
+   - Document authentication methods (API keys, JWT, OAuth)
+   - Explain authorization scopes and permissions
+   - Provide authentication examples and token formats
+   - Document session management and refresh token flows
+7. **Data Model Documentation**
+   - Define all data schemas and models
+   - Document field types, constraints, and validation rules
+   - Include relationships between entities
+   - Provide example data structures
+8. **Error Handling Documentation**
+   - Document all possible error responses
+   - Explain error codes and their meanings
+   - Provide troubleshooting guidance
+   - Include rate limiting and throttling information
+9. **Interactive Documentation Setup**
+   **Swagger UI Integration:**
+   ```html
+   <!DOCTYPE html>
+   <html>
+   <head>
+     <title>API Documentation</title>
+     <link rel="stylesheet" type="text/css" href="./swagger-ui-bundle.css" />
+   </head>
+   <body>
+     <div id="swagger-ui"></div>
+     <script src="./swagger-ui-bundle.js"></script>
+     <script>
+       SwaggerUIBundle({
+         url: './api-spec.yaml',
+         dom_id: '#swagger-ui'
+       });
+     </script>
+   </body>
+   </html>
+   ```
+10. **Code Annotation and Comments**
+    - Add inline documentation to API handlers
+    - Use framework-specific annotation tools:
+      - **Java**: @ApiOperation, @ApiParam (Swagger annotations)
+      - **Python**: Docstrings with FastAPI or Flask-RESTX
+      - **Node.js**: JSDoc comments with swagger-jsdoc
+      - **C#**: XML documentation comments
+11. **Automated Documentation Generation**
+    **For Node.js/Express:**
+    ```javascript
+    const swaggerJsdoc = require('swagger-jsdoc');
+    const swaggerUi = require('swagger-ui-express');
+    const options = {
+      definition: {
+        openapi: '3.0.0',
+        info: {
+          title: 'API Documentation',
+          version: '1.0.0',
+        },
+      },
+      apis: ['./routes/*.js'],
+    };
+    const specs = swaggerJsdoc(options);
+    app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(specs));
+    ```
+12. **Testing Integration**
+    - Generate API test collections from documentation
+    - Include test scripts and validation rules
+    - Set up automated API testing
+    - Document test scenarios and expected outcomes
+13. **Version Management**
+    - Document API versioning strategy
+    - Maintain documentation for multiple API versions
+    - Document deprecation timelines and migration guides
+    - Track breaking changes between versions
+14. **Performance Documentation**
+    - Document rate limits and throttling policies
+    - Include performance benchmarks and SLAs
+    - Document caching strategies and headers
+    - Explain pagination and filtering options
+15. **SDK and Client Library Documentation**
+    - Generate client libraries from API specifications
+    - Document SDK usage and examples
+    - Provide quickstart guides for different languages
+    - Include integration examples and best practices
+16. **Environment-Specific Documentation**
+    - Document different environments (dev, staging, prod)
+    - Include environment-specific endpoints and configurations
+    - Document deployment and configuration requirements
+    - Provide environment setup instructions
+17. **Security Documentation**
+    - Document security best practices
+    - Include CORS and CSP policies
+    - Document input validation and sanitization
+    - Explain security headers and their purposes
+18. **Maintenance and Updates**
+    - Set up automated documentation updates
+    - Create processes for keeping documentation current
+    - Review and validate documentation regularly
+    - Integrate documentation reviews into development workflow
+**Framework-Specific Examples:**
+**FastAPI (Python):**
+```python
+from fastapi import FastAPI
+from pydantic import BaseModel
+app = FastAPI(title="My API", version="1.0.0")
+class User(BaseModel):
+    id: int
+    name: str
+    email: str
+@app.get("/users/{user_id}", response_model=User)
+async def get_user(user_id: int):
+    """Get a user by ID."""
+    return {"id": user_id, "name": "John", "email": "john@example.com"}
+```
+**Spring Boot (Java):**
+```java
+@RestController
+@Api(tags = "Users")
+public class UserController {
+    @GetMapping("/users/{id}")
+    @ApiOperation(value = "Get user by ID")
+    public ResponseEntity<User> getUser(
+        @PathVariable @ApiParam("User ID") Long id) {
+        // Implementation
+    }
+}
+```
+Remember to keep documentation up-to-date with code changes and make it easily accessible to both internal teams and external consumers.

package/components/commands/documentation/docs-maintenance.md ADDED Viewed

@@ -0,0 +1,119 @@
+---
+allowed-tools: Read, Write, Edit, Bash, Grep
+argument-hint: [maintenance-type] | --audit | --update | --validate | --optimize | --comprehensive
+description: Use PROACTIVELY to implement comprehensive documentation maintenance systems with quality assurance, validation, and automated updates
+model: sonnet
+---
+# Documentation Maintenance & Quality Assurance
+Implement comprehensive documentation maintenance system: $ARGUMENTS
+## Current Documentation Health
+- Documentation files: !`find . -name "*.md" -o -name "*.mdx" | wc -l` files
+- Last updates: !`find . -name "*.md" -exec stat -f "%m %N" {} \; | sort -n | tail -5`
+- External links: !`grep -r "http" --include="*.md" . | wc -l` links to validate
+- Image references: !`grep -r "!\[.*\]" --include="*.md" . | wc -l` images to check
+- Documentation structure: @docs/ or detect documentation directories
+## Task
+Create systematic documentation maintenance framework with automated quality assurance, comprehensive validation, content optimization, and regular update procedures.
+## Documentation Maintenance Framework
+### 1. Content Quality Audit System
+- Comprehensive file discovery and categorization
+- Content freshness analysis and aging detection
+- Word count, readability, and structure assessment
+- Missing sections and incomplete documentation identification
+- TODO/FIXME marker tracking and resolution planning
+### 2. Link and Reference Validation
+- External link health monitoring with retry logic
+- Internal link validation and broken reference detection
+- Image reference verification and missing asset identification
+- Cross-reference consistency checking
+- Automated link correction suggestions
+### 3. Style and Consistency Checking
+- Markdown syntax validation and formatting standards
+- Heading hierarchy and structure consistency
+- List formatting and emphasis style uniformity
+- Code block formatting and language specification
+- Accessibility compliance (alt text, descriptive links)
+### 4. Content Optimization and Enhancement
+- Table of contents generation for long documents
+- Metadata updating and frontmatter management
+- Common formatting issue correction
+- Spelling and grammar validation
+- Readability analysis and improvement suggestions
+### 5. Automated Synchronization System
+- Git-based change tracking and documentation updates
+- Version control integration with branch management
+- Automated commit generation with detailed change logs
+- Merge conflict resolution strategies
+- Rollback procedures for failed updates
+### 6. Quality Assurance Reporting
+- Comprehensive audit reports with severity classifications
+- Issue categorization and prioritization systems
+- Progress tracking and maintenance metrics
+- Automated notification systems for critical issues
+- Dashboard creation for ongoing monitoring
+## Implementation Requirements
+### Audit Configuration
+- Configurable quality thresholds and validation rules
+- Custom style guide integration and enforcement
+- Platform-specific optimization settings
+- Team collaboration workflow integration
+- Automated scheduling and recurring maintenance
+### Validation Processes
+- Multi-level validation with error categorization
+- Batch processing for large documentation sets
+- Performance optimization for comprehensive scans
+- Integration with existing CI/CD pipelines
+- Real-time monitoring and alerting systems
+### Reporting and Analytics
+- Detailed maintenance reports with actionable insights
+- Historical trend analysis and improvement tracking
+- Team productivity metrics and documentation health scores
+- Integration with project management tools
+- Automated stakeholder communication
+## Deliverables
+1. **Maintenance System Architecture**
+   - Automated audit and validation framework
+   - Content optimization and enhancement tools
+   - Quality assurance reporting infrastructure
+   - Version control integration and synchronization
+2. **Validation and Quality Tools**
+   - Link checking and reference validation systems
+   - Style consistency and accessibility compliance tools
+   - Content freshness and completeness analyzers
+   - Automated correction and enhancement utilities
+3. **Reporting and Monitoring**
+   - Comprehensive audit reports with prioritized recommendations
+   - Real-time monitoring dashboards and alert systems
+   - Progress tracking and maintenance history documentation
+   - Integration with team communication and project tools
+4. **Documentation and Procedures**
+   - Implementation guidelines and configuration instructions
+   - Team workflow integration and collaboration procedures
+   - Troubleshooting guides and maintenance best practices
+   - Automated scheduling and recurring maintenance setup
+## Integration Guidelines
+Implement with existing documentation platforms and development workflows. Ensure scalability for large documentation sets and team collaboration while maintaining quality standards and accessibility compliance.

package/components/commands/documentation/generate-api-documentation.md ADDED Viewed

@@ -0,0 +1,97 @@
+---
+allowed-tools: Read, Write, Edit, Bash
+argument-hint: [output-format] | --swagger-ui | --redoc | --postman | --insomnia | --multi-format
+description: Auto-generate API reference documentation with multiple output formats and automated deployment
+model: sonnet
+---
+# Automated API Documentation Generator
+Auto-generate API reference documentation: $ARGUMENTS
+## Current API Infrastructure
+- Code annotations: !`grep -r "@api\|@swagger\|@doc" src/ 2>/dev/null | wc -l` annotations found
+- API framework: @package.json or detect from imports
+- Existing specs: !`find . -name "*spec*.yaml" -o -name "*spec*.json" | head -3`
+- Documentation tools: !`grep -E "swagger|redoc|postman" package.json 2>/dev/null || echo "None detected"`
+- CI/CD pipeline: @.github/workflows/ (if exists)
+## Task
+Setup automated API documentation generation with modern tooling:
+1. **API Documentation Strategy Analysis**
+   - Analyze current API structure and endpoints
+   - Identify documentation requirements (REST, GraphQL, gRPC, etc.)
+   - Assess existing code annotations and documentation
+   - Determine documentation output formats and hosting requirements
+   - Plan documentation automation and maintenance strategy
+2. **Documentation Tool Selection**
+   - Choose appropriate API documentation tools:
+     - **OpenAPI/Swagger**: REST API documentation with Swagger UI
+     - **Redoc**: Modern OpenAPI documentation renderer
+     - **GraphQL**: GraphiQL, Apollo Studio, GraphQL Playground
+     - **Postman**: API documentation with collections
+     - **Insomnia**: API documentation and testing
+     - **API Blueprint**: Markdown-based API documentation
+     - **JSDoc/TSDoc**: Code-first documentation generation
+   - Consider factors: API type, team workflow, hosting, interactivity
+3. **Code Annotation and Schema Definition**
+   - Add comprehensive code annotations for API endpoints
+   - Define request/response schemas and data models
+   - Add parameter descriptions and validation rules
+   - Document authentication and authorization requirements
+   - Add example requests and responses
+4. **API Specification Generation**
+   - Set up automated API specification generation from code
+   - Configure OpenAPI/Swagger specification generation
+   - Set up schema validation and consistency checking
+   - Configure API versioning and changelog generation
+   - Set up specification file management and version control
+5. **Interactive Documentation Setup**
+   - Configure interactive API documentation with try-it-out functionality
+   - Set up API testing and example execution
+   - Configure authentication handling in documentation
+   - Set up request/response validation and examples
+   - Configure API endpoint categorization and organization
+6. **Documentation Content Enhancement**
+   - Add comprehensive API guides and tutorials
+   - Create authentication and authorization documentation
+   - Add error handling and status code documentation
+   - Create SDK and client library documentation
+   - Add rate limiting and usage guidelines
+7. **Documentation Hosting and Deployment**
+   - Set up documentation hosting and deployment
+   - Configure documentation website generation and styling
+   - Set up custom domain and SSL configuration
+   - Configure documentation search and navigation
+   - Set up documentation analytics and usage tracking
+8. **Automation and CI/CD Integration**
+   - Configure automated documentation generation in CI/CD pipeline
+   - Set up documentation deployment automation
+   - Configure documentation validation and quality checks
+   - Set up documentation change detection and notifications
+   - Configure documentation testing and link validation
+9. **Multi-format Documentation Generation**
+   - Generate documentation in multiple formats (HTML, PDF, Markdown)
+   - Set up downloadable documentation packages
+   - Configure offline documentation access
+   - Set up documentation API for programmatic access
+   - Configure documentation syndication and distribution
+10. **Maintenance and Quality Assurance**
+    - Set up documentation quality monitoring and validation
+    - Configure documentation feedback and improvement workflows
+    - Set up documentation analytics and usage metrics
+    - Create documentation maintenance procedures and guidelines
+    - Train team on documentation best practices and tools
+    - Set up documentation review and approval processes

package/components/commands/documentation/interactive-documentation.md ADDED Viewed

@@ -0,0 +1,133 @@
+---
+allowed-tools: Read, Write, Edit, Bash
+argument-hint: [platform] | --docusaurus | --gitbook | --notion | --storybook | --jupyter | --comprehensive
+description: Use PROACTIVELY to create interactive documentation platforms with live examples, code playgrounds, and user engagement features
+model: sonnet
+---
+# Interactive Documentation Platform
+Create interactive documentation with live examples: $ARGUMENTS
+## Current Documentation Infrastructure
+- Static site generators: !`find . -name "docusaurus.config.js" -o -name "gatsby-config.js" -o -name "_config.yml" | head -3`
+- Documentation framework: @docs/ or @website/ (detect existing setup)
+- Component libraries: !`find . -name "*.stories.*" | head -5` (Storybook detection)
+- Interactive examples: !`find . -name "*.ipynb" -o -name "*playground*" | head -3`
+- Hosting setup: @vercel.json or @netlify.toml or @.github/workflows/ (if exists)
+## Task
+Build comprehensive interactive documentation platform with live code examples, user engagement features, and multi-platform integration capabilities.
+## Interactive Documentation Architecture
+### 1. Platform Foundation and Configuration
+- Documentation platform selection and optimization setup
+- Theme customization and branding configuration
+- Navigation structure and content organization
+- Multi-language support and internationalization
+- Search integration with advanced filtering and indexing
+### 2. Live Code Playground Integration
+- Interactive code editor with syntax highlighting
+- Real-time code execution and preview capabilities
+- Multi-language support and framework integration
+- Error handling and debugging assistance
+- Code sharing and collaboration features
+### 3. API Documentation and Testing
+- Interactive API endpoint exploration
+- Live request/response testing capabilities
+- Parameter validation and example generation
+- Authentication flow integration
+- Response schema visualization and validation
+### 4. Interactive Tutorial System
+- Step-by-step guided learning experiences
+- Progress tracking and completion validation
+- Hands-on coding exercises with instant feedback
+- Adaptive learning paths based on user progress
+- Gamification elements and achievement systems
+### 5. Component Documentation Integration
+- Live component playground with property controls
+- Visual component gallery with interactive examples
+- Design system integration and style guide generation
+- Accessibility testing and compliance validation
+- Cross-browser compatibility testing
+### 6. User Engagement and Feedback Systems
+- Rating and review collection mechanisms
+- User feedback aggregation and analysis
+- Community discussion and Q&A integration
+- Usage analytics and behavior tracking
+- Personalization and recommendation systems
+### 7. Content Management and Publishing
+- Version control integration with automated publishing
+- Content review and approval workflows
+- Multi-author collaboration and editing
+- Content scheduling and automated updates
+- SEO optimization and metadata management
+### 8. Advanced Interactive Features
+- Advanced search with faceted filtering and suggestions
+- Interactive diagrams and visualization tools
+- Embedded video content and multimedia integration
+- Mobile-responsive design and offline capabilities
+- Progressive web app features and notifications
+## Implementation Requirements
+### Platform Integration
+- Multi-framework support (React, Vue, Angular, vanilla JS)
+- Build system integration with automated deployment
+- Content management system compatibility
+- Third-party service integration (analytics, feedback, search)
+- Performance optimization and bundle splitting
+### User Experience Design
+- Responsive design across all device types
+- Accessibility compliance (WCAG 2.1 AA standards)
+- Progressive enhancement for feature degradation
+- Fast loading times and optimal Core Web Vitals
+- Intuitive navigation and content discovery
+### Technical Infrastructure
+- Scalable hosting and CDN configuration
+- Database integration for user data and analytics
+- API design for external integrations
+- Security implementation and user authentication
+- Monitoring and error tracking systems
+## Deliverables
+1. **Interactive Platform Architecture**
+   - Complete documentation platform setup and configuration
+   - Live code playground and API testing integration
+   - Interactive tutorial system with progress tracking
+   - Component documentation with visual examples
+2. **User Engagement Systems**
+   - Feedback collection and analysis mechanisms
+   - User analytics and behavior tracking implementation
+   - Community features and discussion integration
+   - Personalization and recommendation engines
+3. **Content Management Framework**
+   - Automated publishing and deployment pipelines
+   - Multi-author collaboration and review workflows
+   - Version control integration with change tracking
+   - SEO optimization and metadata management
+4. **Performance and Optimization**
+   - Mobile-responsive design with offline capabilities
+   - Performance monitoring and optimization implementation
+   - Accessibility compliance and testing frameworks
+   - Progressive web app features and service workers
+## Integration Guidelines
+Implement with modern documentation platforms and development workflows. Ensure scalability for large content repositories and team collaboration while maintaining optimal performance and user experience across all devices and platforms.

package/components/commands/documentation/load-llms-txt.md ADDED Viewed

@@ -0,0 +1,39 @@
+---
+allowed-tools: Bash, WebFetch
+argument-hint: [data-source] | --xatu | --custom-url | --validate
+description: Load and process external documentation context from llms.txt files or custom sources
+model: sonnet
+---
+# External Documentation Context Loader
+Load external documentation context: $ARGUMENTS
+## Current Context Status
+- Network access: !`curl -s --connect-timeout 5 https://httpbin.org/status/200 >/dev/null && echo "✅ Available" || echo "❌ Limited"`
+- Existing context: Check for local llms.txt or documentation cache
+- Project type: @package.json or @README.md (detect project context needs)
+## Task
+Load and process external documentation context from specified source.
+### Default Action (Xatu Data)
+Load the llms.txt file from Xatu data repository:
+```bash
+curl -s https://raw.githubusercontent.com/ethpandaops/xatu-data/refs/heads/master/llms.txt
+```
+### Custom Source Loading
+For custom URLs or alternative documentation sources:
+- Validate URL accessibility
+- Download and cache content
+- Process and structure information
+- Integration with project context
+### Processing Options
+- **Raw loading**: Direct content retrieval
+- **Validation**: Check content format and structure
+- **Integration**: Merge with existing project documentation
+- **Caching**: Store locally for offline access