Moxie Docs

O que é o Moxie Docs?

O Moxie Docs é um sistema de documentação para repositórios GitHub que gera e mantém automaticamente a documentação da base de código. Ele indexa um repositório, cria documentação pesquisável para arquitetura, convenções e walkthroughs, e reavalia essas páginas quando o código muda, para que material desatualizado possa ser sinalizado e reescrito.

Ele também expõe convenções do repositório e contexto verificado para ferramentas de IA via MCP, com acesso somente leitura limitado à tarefa. Além disso, pode abrir uma pull request semanal de “Friday Cleanup” apenas de documentação para reunir desvios acumulados ao longo da semana.

Principais funcionalidades

• Indexação contínua do repositório: o Moxie se conecta a um repositório GitHub e mantém o índice atualizado conforme os merges acontecem, para que a documentação fique ligada ao código mais recente.
• Documentação gerada e com fontes citadas: cria páginas de arquitetura, convenções e walkthroughs com citações que apontam para o código-fonte, o que torna o resultado mais fácil de verificar.
• Detecção de desvio no merge: quando mudanças no código afetam a documentação existente, o Moxie sinaliza o desvio e gera novamente as páginas relevantes em vez de deixá-las desatualizadas.
• Contexto MCP para agentes: ferramentas de IA como Cursor, Claude Code e Codex podem acessar convenções, documentação e comandos verificados via MCP sem revarrer o repositório a cada prompt.
• Pull requests de Friday Cleanup: uma vez por semana, o Moxie pode abrir uma pull request apenas de documentação para reunir e apresentar as atualizações para revisão.
• Verificações no fluxo de PR: pode checar pull requests quanto ao impacto na documentação e ao alinhamento da descrição antes do merge, deixando as mudanças de código e o controle de merge com a equipe.

Como usar o Moxie Docs

Comece conectando um repositório GitHub. O Moxie indexa a base de código, gera o primeiro conjunto de documentação e resume convenções que podem ser reutilizadas por pessoas ou agentes de IA.

A partir daí, as equipes o usam de duas formas principais: revisando a documentação que o Moxie gera e atualiza, e deixando que ele verifique novos pull requests em busca de documentação desatualizada ou descrições inconsistentes. Se desejado, a integração MCP pode ser usada por agentes de programação para recuperar contexto específico do repositório de forma limitada e somente leitura.

Casos de uso

• Manter a documentação de arquitetura atualizada: uma equipe mantém páginas como comportamento de webhooks ou fluxos de cobrança, com o Moxie atualizando a documentação quando mudanças relacionadas no código são incorporadas.
• Fornecer contexto do repositório a agentes de programação: desenvolvedores usando Cursor, Claude Code ou Codex podem recuperar convenções e comandos verificados sem navegar manualmente pelo repositório.
• Revisar desvios de documentação semanalmente: equipes que querem uma cadência regular de limpeza podem revisar a pull request semanal de Friday Cleanup em vez de correr atrás de páginas desatualizadas de forma ad hoc.
• Verificar o impacto de PRs antes do merge: mantenedores podem ver se uma pull request afeta a documentação ou se precisa de reescrita da descrição antes de ser mesclada.
• Onboarding de novos engenheiros: novos colaboradores podem pesquisar a documentação gerada e bookmarks em um único workspace, em vez de ler vários arquivos-fonte para entender as convenções.

FAQ

O Moxie altera meu código automaticamente? Não. A fonte diz que as mudanças de código continuam sob controle da equipe. As atualizações de documentação são entregues como pull requests de documentação revisáveis, e os ajustes de alinhamento da descrição editam a descrição do PR, não o código.

O que acontece depois que conecto um repositório? O Moxie indexa o repositório, gera documentação pesquisável, resume convenções e começa a verificar novos pull requests quanto ao impacto na documentação e ao alinhamento da descrição.

O acesso ao repositório é limitado? Sim. A descrição do produto diz que o acesso é somente leitura por padrão e limitado por repositório, e que o contexto MCP fica restrito à tarefa, não à base de código completa.

Que tipos de documentação ele gera? A página menciona especificamente páginas de arquitetura, convenções, walkthroughs e documentação para tópicos como webhooks de cobrança.

Ele funciona apenas com GitHub? A página foi escrita para repositórios GitHub, então o GitHub é a fonte suportada descrita aqui.

Alternativas

• Documentação manual em Markdown ou em um wiki de docs: Esta é a alternativa mais simples, mas não revalida automaticamente a documentação com o código nem gera atualizações com fontes citadas.
• Ferramentas gerais de busca de código e navegação de repositórios: Ajudam as pessoas a inspecionar arquivos, mas não oferecem uma camada de documentação mantida nem PRs de limpeza apenas de docs.
• Assistentes de codificação de IA independentes, sem docs cientes do repositório: Podem responder perguntas e editar código, mas ainda dependem de o modelo redescobrir o contexto, a menos que sejam combinados com um sistema como o Moxie.
• Fluxos internos de documentação baseados em pull requests e revisão: As equipes podem gerenciar docs manualmente por meio de PRs, mas precisam criar e acompanhar os próprios checks de drift em vez de recebê-los gerados a partir da base de código.