rails-controller-docs

Rails Controller Documentation Generator

Goal

Generate comprehensive markdown documentation for a Rails controller, including all actions, routes, request/response formats, authentication requirements, and business logic.

CRITICAL: MANDATORY PROCESS

Follow these steps IN EXACT ORDER. DO NOT skip any step:

Step 1: Identify the Controller (MANDATORY)

YOU MUST determine which controller file to document:

• IF user specifies a controller file → Use that file path
• IF a file is currently open in the editor → Check if it's a controller file
• IF neither of the above → STOP and ask the user to provide the controller file path

DO NOT proceed without a valid controller file path.

Step 2: Read the Controller File (MANDATORY)

YOU MUST run: Read the entire controller file from start to finish.

• DO NOT assume you know the controller structure
• DO NOT skip reading the full file
• DO NOT use partial context or memory

Step 3: Gather Additional Context (REQUIRED)

Read these files if they exist (in order):

1. Routes file: config/routes.rb - to get route definitions
2. Related models: Any models referenced in the controller (e.g., if you see User.find, read app/models/user.rb)
3. Concern modules: Any concerns included in the controller (e.g., include Authenticatable)
4. Parent controller: Check for authentication/authorization in ApplicationController if referenced

Step 4: Analyze Controller Structure (MANDATORY)

Before generating documentation, identify:

• All public actions (methods)
• All before_action / after_action / around_action filters
• Authentication/authorization methods
• Private/protected helper methods
• Strong parameters (permit/require patterns)

Step 5: Generate Documentation (MANDATORY)

Create comprehensive documentation following the format specified below.

Output to Chat ONLY - DO NOT create files.

Use four backticks (````) for the outer markdown code block.