// Generate documentation comments, README files, and API documentation for Wheels applications. Use when documenting code, creating project READMEs, or generating API docs.
Automatically detect and prevent common Wheels framework errors before code is generated. This skill activates during ANY Wheels code generation (models, controllers, views, migrations) to validate patterns and prevent known issues. Scans for mixed arguments, query/array confusion, non-existent helpers, and database-specific SQL.
Generate RESTful API controllers with JSON responses, proper HTTP status codes, and API authentication. Use when creating API endpoints, JSON APIs, or web services. Ensures proper REST conventions and error handling.
Generate authentication system with user model, sessions controller, and password hashing. Use when implementing user authentication, login/logout, or session management. Provides secure authentication patterns and bcrypt support.
Generate Wheels MVC controllers with CRUD actions, filters, parameter verification, and proper rendering. Use when creating or modifying controllers, adding actions, implementing filters for authentication/authorization, handling form submissions, or rendering views/JSON. Ensures proper Wheels conventions and prevents common controller errors.
Troubleshoot common Wheels errors and provide debugging guidance. Use when encountering errors, exceptions, or unexpected behavior. Provides error analysis, common solutions, and debugging strategies for Wheels applications.
Configure Wheels applications for production deployment with security hardening, performance optimization, and environment-specific settings. Use when preparing for production, configuring servers, or hardening security.
| name | Wheels Documentation Generator |
| description | Generate documentation comments, README files, and API documentation for Wheels applications. Use when documenting code, creating project READMEs, or generating API docs. |
/**
* Authenticate user with email and password
*
* @param email User's email address
* @param password User's password (plain text)
* @return User object if authenticated, false otherwise
*/
public any function authenticate(required string email, required string password) {
// Implementation
}
/**
* Post Model
*
* Represents a blog post with associated comments and tags.
*
* Associations:
* - hasMany: comments (dependent delete)
* - hasManyThrough: tags (through postTags)
* - belongsTo: user
*
* Validations:
* - title: presence, length (3-200)
* - slug: presence, uniqueness
* - content: presence, minimum length (10)
*/
component extends="Model" {
// Implementation
}
# Project Name
## Description
Brief description of the application.
## Requirements
- CFWheels 3.0+
- Lucee 5.x / Adobe ColdFusion 2018+
- Database (MySQL, PostgreSQL, SQL Server)
## Installation
1. Clone repository
2. Run migrations: `wheels dbmigrate latest`
3. Start server: `wheels server start`
## Configuration
Configure database in `config/database.cfm`
## Testing
Run tests: `wheels test run`
## License
MIT
Generated by: Wheels Documentation Generator Skill v1.0