Docudoodle é um pacote gerador de documentação PHP para Laravel que analisa sua base de código e cria documentação usando a IA de sua escolha. O Docudoodle ajuda você a entender melhor sua base de código e pode ajudar a documentar bases de código legadas ou existentes com as quais você acabou de começar a trabalhar.

Após instalar este pacote, você pode gerar a documentação usando o comando Artisan do pacote. Após a conclusão, a documentação estará disponível na documentation/ pasta do seu projeto:

php artisan docudoodle:generate

Você pode usar o modelo de sua escolha, com o projeto oferecendo opções de configuração OpenAI, Claude, Gemini e Ollama. Aqui estão as opções de configuração do pacote no momento da escrita:

return [
    'openai_api_key' => env('OPENAI_API_KEY', ''),
    'claude_api_key' => env('CLAUDE_API_KEY', ''),
    'default_model' => env('DOCUDOODLE_MODEL', 'gpt-4o-mini'),
    'max_tokens' => env('DOCUDOODLE_MAX_TOKENS', 10000),
    'default_extensions' => ['php', 'yaml', 'yml'],
    'default_skip_dirs' => ['vendor/', 'node_modules/', 'tests/', 'cache/'],
    'ollama_host' => env('OLLAMA_HOST', 'localhost'),
    'ollama_port' => env('OLLAMA_PORT', '11434'),
    'gemini_api_key' => env('GEMINI_API_KEY', ''),
    'default_api_provider' => env('DOCUDOODLE_API_PROVIDER', 'openai'),
];

# Principais Características

• Geração Automática de Documentação : Gera documentação para arquivos PHP sem esforço, analisando seu conteúdo.
• Integração flexível de IA : escolha entre a poderosa API de nuvem da OpenAI, a API Claude, a API Gemini do Google ou execute localmente com modelos Ollama para privacidade total.
• Suporte Ollama : gere documentação completamente offline usando seus próprios modelos Ollama locais - perfeito para bases de código privadas ou quando você precisa trabalhar sem uma conexão com a internet.
• Personalizável : configure facilmente diretórios de origem, pastas de saída e outras configurações para corresponder ao seu fluxo de trabalho.
• Interface de linha de comando : inclui um script de linha de comando simples para geração rápida de documentação.

Você pode aprender mais sobre este pacote, obter instruções completas de instalação e visualizar o código-fonte no GitHub. O repositório de pacotes possui alguns exemplos para que você possa ter uma ideia do que esperar da documentação final.