Communitygithub.com

chenrui333/codex-docs

Skill para gerar e buscar documentação da base de código usando Codex.

O que é codex-docs?

Este skill permite que agentes de IA (como Claude Code, Cursor, Codex) gerem e pesquisem documentação da base de código de forma eficiente. Ele integra ferramentas como `codex` e `docusaurus` para criar, atualizar e visualizar documentação técnica diretamente no repositório. Suporta plataformas onde `codex` está disponível, fornecendo comandos para indexar código, extrair comentários e estruturar documentação em Markdown. Útil para manter documentação sempre atualizada com o código, facilitando a onboarding de novos desenvolvedores e a navegação em projetos complexos.

Funciona com~Claude Code✓Codex CLI~Cursor
npx skills add chenrui333/codex-docs

Perguntar na sua IA favorita

Abre um novo chat com esta habilidade de agente já pré-carregada.

Documentação

O que codex-docs faz?

Skill para gerar e buscar documentação da base de código usando Codex.

Descrição

Este skill permite que agentes de IA como Claude Code, Cursor e Codex criem, pesquisem e mantenham documentação do código-fonte de forma automatizada.

Funcionalidades

  • Geração automática de documentação a partir de comentários e estrutura do código
  • Busca inteligente em documentação existente
  • Integração com ferramentas como Docusaurus para visualização
  • Indexação de código para referência rápida

Como usar

# Indexar o código atual
codex index

# Gerar documentação
codex docs generate

# Buscar documentação
codex docs search "termo de busca"

Plataformas suportadas

  • Claude Code
  • Cursor
  • Codex CLI
  • Outras ferramentas compatíveis com Codex

Requisitos

  • Ter o codex instalado e configurado
  • Acesso ao repositório de código

Exemplo de uso

# No diretório do projeto
codex index --format markdown
codex docs generate --output docs/

Licença

MIT

Habilidades Relacionadas