The AI README Generator module allows you to automatically generate a README.md file for any installed contrib or custom Drupal module. It extracts relevant metadata from the module’s codebase and sends it to an AI service to create a structured, professional README file.

Features

One-click README generation using AI.

Integrates with your own AI provider via a configurable form.

Automatically scans the selected module’s .info.yml, PHP classes, hooks, and more.

Supports custom module discovery and simple file creation.

Why and when to use:
If you’re building custom modules or maintaining multiple contrib modules and want consistent, high-quality README documentation without manually writing it, this module saves you time and effort. It’s advantageous during early development, module publishing, or codebase cleanup.

Use cases:

Developers are preparing modules for contribution on Drupal.org.

Teams are documenting internal custom modules.

Anyone wanting fast, AI-assisted documentation with minimal manual effort.

Additional Requirements

A valid API key and AI Provider.

PHP package: innoraft/ai-readme-generator, installed via Composer.

PHP >= 8.1 recommended.

Recommended modules/libraries

Admin Toolbar (for easier navigation to the configuration forms).

Similar projects

There are no widely known Drupal modules that generate README files using AI. Some tools, like Drupal Code Generator or Module Builder, help scaffold code but do not focus on documentation.

What makes this different:

Focused on documentation, not code scaffolding.

Uses AI to generate content based on real module code.

Designed to be hands-off: one form, one click, one README.

Supporting this Module

This module is developed and maintained by Innoraft.

AI Readme Generator

Issues

Add Gitlab CI templateActiveCode Created about 1 month ago

Add Gitlab CI template
Active
Code
Created about 1 month ago