wheels-documentation-generator
Generate documentation comments, README files, and API documentation for Wheels applications. Use when documenting code, creating project READMEs, or generating API docs.
Installation
Details
Usage
After installing, this skill will be available to your AI coding assistant.
Verify installation:
skills listSkill Instructions
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.
Wheels Documentation Generator
Function Documentation
/**
* 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
}
Model Documentation
/**
* 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
}
README Template
# Project Name
## Description
Brief description of the application.
## Requirements
- Wheels 3.0+
- Lucee 5.x / Adobe ColdFusion 2018+
- Database (MySQL, PostgreSQL, SQL Server, Oracle, SQLite)
## 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
More by wheels-dev
View allGenerate 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.
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.
Generate documentation comments, README files, and API documentation for Wheels applications. Use when documenting code, creating project READMEs, or generating API docs.
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.