Moxie Docs

Atualizações automáticas de documentação a partir de agentes e convenções de código para reduzir o uso de tokens.

Ver em moxiedocs.comExperimente este MCPPatrocinado

Documentação

Moxie Docs

Comece gratuitamente em um repositório, sem necessidade de cartão de crédito. Verificações de PR que sinalizam lacunas na documentação, documentação viva revalidada a cada merge, contexto MCP para agentes de IA, bases de conhecimento públicas hospedadas e PRs de Limpeza de Sexta-feira vindos do GitHub.

Moxie Docs é um serviço hospedado que se conecta aos seus repositórios GitHub, mantém uma base de conhecimento pesquisável do seu código em sincronia a cada merge e fornece esse contexto a agentes de codificação de IA via MCP. Criado por jackalope.digital.

Produto

  • Visão geral: Documentação automatizada de código para GitHub — documentação pesquisável, contexto MCP e PRs de Limpeza de Sexta-feira.
  • Como funciona: Indexação, geração de documentação, detecção de desatualização e PRs de Limpeza de Sexta-feira.
  • Casos de uso: Onboarding, documentação de arquitetura e contexto para agentes de IA.
  • Servidor MCP: Como agentes de IA consultam o contexto do seu código via Model Context Protocol.
  • Documentação de código automatizada: Gere documentação de código pesquisável a partir do GitHub automaticamente. Arquitetura, convenções, fluxos entre arquivos, detecção de desatualização, contexto MCP e PRs de Limpeza de Sexta-feira.
  • Detecção de desatualização de documentação: Detecte desatualização de documentação e corrija documentos obsoletos a cada merge. Superficie lacunas e abra um PR de Limpeza de Sexta-feira revisável para que a wiki não apodreça silenciosamente.
  • Central de ferramentas gratuitas: Diagramas ER de SQL no navegador, utilitários para README, Mermaid, ADR, AGENTS.md e llms.txt — sem necessidade de conta.
  • Código aberto: Como o Moxie Docs apoia e trabalha com repositórios de código aberto.

Integrações com agentes

Conecte o contexto MCP do Moxie Docs aos agentes que sua equipe já usa:

  • Cursor: Conecte o Cursor à documentação viva, convenções e lacunas de documentação do seu repositório via MCP. Um único comando de configuração após conectar o GitHub — sem empacotamento manual de contexto.
  • Claude Code: Dê ao Claude Code convenções do repositório, documentação gerada e lacunas de documentação via MCP — e mantenha AGENTS.md e CLAUDE.md alinhados com o código que é entregue.
  • Codex: Conecte o OpenAI Codex à documentação e convenções vivas do código via MCP. Contexto compacto do Moxie Docs para menos leituras exploratórias e melhores edições.
  • Windsurf: Conecte o Windsurf ao Moxie Docs via MCP para documentação viva do código, convenções e lacunas de documentação. Um único comando de configuração após conectar o GitHub.
  • Cline & Roo Code: Conecte Cline e Roo Code à documentação viva do código, convenções e lacunas de documentação do seu repositório via MCP. Zero empacotamento manual de contexto.
  • GitHub Copilot: Dê ao GitHub Copilot Agent Mode convenções vivas do repositório e lacunas de documentação via MCP — e mantenha .github/copilot-instructions.md atualizado.

Soluções

Como o Moxie Docs se adapta a cada função de engenharia e configuração organizacional:

O que os desenvolvedores dizem

Citações do lançamento no Product Hunt e outras avaliações:

  • Zaid Mallik: "A qualidade do contexto parece estar se tornando um gargalo maior do que a qualidade do modelo para muitos fluxos de trabalho com agentes." (@zaidmallik · Product Hunt)
  • GlyphHarbor: "Documentação que viaja para dentro do assistente de codificação é a parte que parece certa aqui. Um README no GitHub é útil, mas no momento em que estou em um loop com Claude/Codex a questão é se a regra atual está de fato diante do modelo." (@glyphharbor · Product Hunt)
  • MakerStack: "O Moxie Docs ataca o problema real da documentação desatualizada ao gerar documentação automaticamente e sinalizar desatualização no merge, o que é inteligente." (Avaliação de produto · MakerStack)
  • Paul Crinigan: "A verificação de PR é a parte que eu destacaria. Documentação apodrece porque nada no fluxo de trabalho nunca diz que ela apodreceu, então uma verificação que falha ruidosamente no diff vale mais do que qualquer quantidade de qualidade de geração." (@paul_crinigan · Product Hunt)
  • Grace Lee: "Isso parece útil porque a documentação está começando a atender dois públicos ao mesmo tempo: humanos lendo a base de conhecimento pública e agentes de IA usando o contexto do repositório enquanto o trabalho acontece." (@grace_lee26 · Product Hunt)
  • Adrian Ciaschetti: "A ideia da Limpeza de Sexta-feira é agradavelmente contida. Agrupar desatualização de documentação em um único PR revisável, sem nada de auto-merge, parece um hábito muito mais fácil para uma equipe confiar." (@adriancia · Product Hunt)

Preços

Três planos, cada um com teste gratuito de 14 dias. Todo plano pode ser cobrado mensal ou anualmente; a cobrança anual equivale a dois meses grátis (cerca de 17% de desconto):

  • Free - $0/mês ou $0/ano: Veja funcionando em um repositório real antes de decidir qualquer coisa. Sem necessidade de cartão. Até 1 repositório, 1 assento.
  • Starter - $29/mês ou $290/ano: Para criadores solo documentando alguns repositórios privados. Até 5 repositórios, 1 assento.
  • Pro - $79/mês ou $790/ano: Documentação sem intervenção para uma equipe em crescimento: Recaps semanais, PRs de Limpeza automatizados e espaço para muitos repositórios. Até 15 repositórios, 10 assentos.
  • Team - $199/mês ou $1.990/ano: Para organizações com uma frota de serviços: assentos ilimitados, indexação prioritária e a maior capacidade. Até 50 repositórios, assentos ilimitados.

Especificações do produto

Implantação: SaaS hospedado. Conecta-se ao GitHub por meio de um GitHub App com escopo restrito e privilégio mínimo, com acesso somente leitura ao repositório; o Moxie Docs nunca faz commit no seu código e nunca faz merge de nada — a documentação chega apenas como pull requests revisáveis.

Endpoint MCP: Um servidor Model Context Protocol em https://moxiedocs.com/api/mcp serve convenções, documentação, lacunas de documentação e comandos verificados para agentes de codificação de IA como Cursor, Claude Code, Codex e outros clientes compatíveis com MCP, para que os agentes façam uma consulta com escopo definido em vez de revarrer o repositório a cada prompt.

Planos de preço: Free $0/mês, Starter $29/mês, Pro $79/mês, Team $199/mês. Todo plano inclui teste gratuito de 14 dias e é precificado por repositório, não por assento; a cobrança anual equivale a cerca de dois meses grátis.

Capacidades principais: Documentação de código automatizada, detecção de desatualização de documentação a cada merge, PRs semanais de Limpeza de Sexta-feira, busca interativa no código, contexto MCP para agentes de codificação de IA e bases de conhecimento públicas hospedadas.

Recursos para desenvolvedores

Comparações

  • Visão geral das comparações: Todas as páginas de comparação em um só lugar.
  • Moxie Docs vs Mintlify: Contexto do código vs. agente de site de documentação: o Moxie Docs mapeia sua arquitetura e a serve a agentes de codificação via MCP; o agente de IA do Mintlify redige atualizações para o seu site de documentação.
  • Moxie Docs vs Jamdesk: Geração vs. publicação: o Moxie Docs escreve e mantém documentação a partir do seu código; o Jamdesk hospeda o MDX que você mesmo cria, com preço fixo e chat de IA voltado ao leitor.
  • Moxie Docs vs Context7: Seu código vs. documentação de bibliotecas públicas: o Moxie gera e mantém documentação para o seu próprio repositório e a serve via MCP; o Context7 injeta documentação atualizada de bibliotecas de terceiros nos seus prompts.
  • Moxie Docs vs Swimm: Self-serve vs. liderado por vendas: wikis de código com zero manutenção a partir de análise contínua do repositório, sem necessidade de chamada de discovery para ver preços ou começar.
  • Moxie Docs vs Docusaurus: Geração vs. publicação: o Moxie escreve e mantém documentação a partir do seu código-fonte e a serve a agentes via MCP; o Docusaurus é um gerador de site estático de código aberto para documentação que você escreve e hospeda você mesmo.
  • Moxie Docs vs GitBook: Nativo de código vs. wiki multifuncional: documentação acoplada ao código e gerada por IA, sem o licenciamento por assento do GitBook.
  • Moxie Docs vs Google Code Wiki: Repositórios privados vs. pré-visualização pública: o Moxie Docs documenta seu código privado e abre pull requests; o Google Code Wiki é uma wiki gratuita somente leitura para repositórios públicos.
  • Moxie Docs vs Confluence: Sincronização automatizada de código vs. cemitério de texto legado: a documentação permanece acoplada ao código em vez de ficar desatualizada.
  • Moxie Docs vs Repowise: GitHub App hospedado vs. daemon auto-hospedado: o Moxie Docs abre pull requests somente de documentação sem nada para instalar, em vez de você rodar seu próprio daemon de indexação.
  • Moxie Docs vs Merge.dev: MCP nativo de código vs. API unificada de integrações: servidores MCP sem código que servem contexto do repositório a agentes.
  • Moxie Docs vs Cursor Rules: Gerado vs. escrito à mão: o Moxie Docs serve convenções do repositório via MCP que se atualizam a partir do seu código, em vez de arquivos de regras que alguém precisa escrever e manter manualmente.
  • Moxie Docs vs DocuWriter.ai: Pull requests somente de documentação vs. um espaço de documentação: ambos geram documentação para todo o repositório e um servidor MCP, mas o Moxie Docs roteia atualizações por pull requests do GitHub e adiciona um site de base de conhecimento pública.

Comparações diretas entre ferramentas de documentação:

  • Mintlify vs GitBook: Fluxo de trabalho MDX para desenvolvedores vs. um editor de blocos para equipes mistas.
  • GitBook vs Confluence: Plataforma de documentação feita para isso vs. a wiki empresarial genérica.
  • Mintlify vs Confluence: Documentação MDX acoplada ao código vs. uma wiki empresarial desacoplada.
  • Mintlify vs Docusaurus: Plataforma MDX gerenciada vs. gerador de site estático gratuito e de código aberto.
  • GitBook vs Docusaurus: Editor de blocos para equipes mistas vs. sites Markdown auto-hospedados.
  • Mintlify vs Swimm: Hospedagem refinada de documentação pública vs. walkthroughs de onboarding ancorados no código.
  • Mintlify vs Jamdesk: Plataforma de documentação premium com um agente de IA vs. hospedagem MDX com preço fixo.

Aprenda

Guias sobre MCP, documentação e práticas de desenvolvimento com IA:

Recursos

  • Blog: Artigos sobre documentação, bases de código e ferramentas de IA para desenvolvedores. Feed RSS completo em /blog/feed.xml.
  • Arquivo de contexto completo: Guias incorporados, resumos de ferramentas e FAQ para ingestão por IA.
  • FAQ: Respostas sobre geração de documentação, acesso e segurança no GitHub, contexto MCP, idiomas suportados e preços.
  • Segurança: Como o Moxie Docs lida com dados e acesso a repositórios.
  • Contato: Fale com a equipe.

FAQ

O que é o Moxie Docs?

Um serviço hospedado que se conecta ao GitHub, gera documentação pesquisável da base de código a partir do código-fonte, mantém tudo atualizado a cada merge e fornece esse contexto a agentes de IA via MCP. Atualizações de documentação chegam como pull requests que sua equipe revisa.

O que acontece depois que eu conecto um repositório?

O Moxie executa um primeiro índice completo, gera documentação e convenções e, em seguida, reindexa a cada merge. Verificações de PR para alinhamento de descrição, lacunas de documentação e convenções começam com os próximos pull requests.

As verificações de PR bloqueiam o merge ou apenas avisam?

Por padrão, elas apenas avisam. O Moxie publica execuções de verificação no GitHub (Moxie Docs / Description, Moxie Docs / Documentation, Moxie Docs / Conventions) com conclusões consultivas sobre os achados — elas não reprovam a verificação e não bloqueiam o merge por conta própria. Para torná-las um bloqueio obrigatório, exija esses nomes de verificação nas regras de proteção de branch do seu repositório.

O Moxie alterará meu código automaticamente?

Não. Atualizações de documentação são PRs revisáveis apenas de documentação. O alinhamento de descrição edita apenas o texto da descrição do PR. O controle de merge permanece com sua equipe.

Como o MCP reduz o custo dos agentes?

Os agentes consultam convenções, documentação, lacunas e comandos verificados em vez de rastrear o repositório novamente a cada prompt — menos tokens e menos suposições erradas. Quando o código não está documentado, o MCP expõe a lacuna em vez de inventar APIs.

Posso publicar uma central de ajuda pública para meus usuários?

Sim — a Base de Conhecimento Pública (Beta) transforma seu repositório em um site de ajuda hospedado em sua-equipe.moxiedocs.app, escrito para usuários finais, desenvolvedores ou ambos. Cada página é aprovada por humanos antes de ir ao ar; notas internas de agentes permanecem fora do site público até você publicar. Disponível em todos os planos durante o beta.

A indexação é única ou contínua?

Contínua. O primeiro índice cria a linha de base. Cada merge reverifica a documentação afetada, sinaliza desvios e lacunas e mantém o contexto MCP atualizado. Nos planos Pro e Team, a Limpeza de Sexta-feira agrupa as correções restantes em um único PR apenas de documentação que você revisa e faz merge — nada é mesclado automaticamente.

Quanto custa?

Gratuito para sempre para um repositório, sem necessidade de cartão. Além disso, o Starter custa US$ 29/mês, o Pro US$ 79/mês e o Team US$ 199/mês, cada um com teste gratuito de 14 dias. A cobrança anual economiza cerca de dois meses. Equipes de repositório único com baixa rotatividade geralmente preferem o Starter anual ou o passe de teste único de US$ 5 em /pricing.

O Moxie Docs funciona com repositórios privados do GitHub?

Sim. Feito para repositórios privados. O GitHub App tem escopo limitado apenas aos repositórios que você escolher, os tokens são criptografados no servidor e o código é usado apenas para gerar documentação e contexto MCP para seu espaço de trabalho.

Quais linguagens de programação o Moxie Docs suporta?

Documentação e busca funcionam com qualquer repositório do GitHub. O Moxie reconhece linguagens principais, incluindo TypeScript, JavaScript, Python, Go, Rust, Ruby, Java, PHP, SQL, Svelte, Vue, Kotlin, Swift, Elixir e Zig, com a análise mais profunda de convenções estruturadas (gráficos de símbolos e importações) para TypeScript/JavaScript e Python.

Como mantenho a documentação sincronizada com meu código?

Conecte um repositório do GitHub. O Moxie reindexa a cada merge, sinaliza páginas afetadas por mudanças de código, regenera documentação desatualizada com diffs citados e, nos planos Pro e Team, executa a Limpeza de Sexta-feira para abrir pull requests semanais apenas de documentação para revisão.

Quanto custa a documentação automatizada de base de código?

O Starter custa US$ 29/mês, o Pro US$ 79/mês e o Team US$ 199/mês, cada um com teste gratuito de 14 dias. A cobrança anual economiza cerca de dois meses em comparação à mensal. Não há SKU de pagamento por uso hoje — o Starter anual é a melhor opção para um único repositório de baixa rotatividade.

Qual é a melhor ferramenta para documentação automatizada de base de código no GitHub?

O Moxie Docs indexa os repositórios que você selecionar por meio de um GitHub App com escopo limitado, gera documentação de arquitetura e convenções fundamentada no código-fonte, detecta desvios de documentação a cada merge e abre PRs semanais de Limpeza de Sexta-feira para que a documentação permaneça atualizada sem reescritas manuais. Ele também expõe um servidor MCP para que Cursor, Claude Code e Codex consultem convenções verificadas em vez de rastrear o repositório novamente.

O que é desvio de documentação e como o Moxie Docs o detecta?

Desvio de documentação é quando a documentação escrita não corresponde mais ao código que descreve. O Moxie Docs verifica cada pull request mesclado contra a documentação que ele afeta, compara a documentação gerada com o código-fonte atual, expõe lacunas no espaço de trabalho e regenera páginas impactadas para que as equipes vejam o que mudou e por quê.

O que é a Limpeza de Sexta-feira no Moxie Docs?

A Limpeza de Sexta-feira é uma automação semanal apenas de documentação nos planos Pro e Team. O Moxie agrupa pequenas correções de documentação — páginas desatualizadas, lacunas e desvios — em um único pull request que sua equipe pode revisar com o café de sexta. Nada é mesclado automaticamente; você segura o botão de merge.

Como os agentes de programação com IA obtêm contexto da base de código do Moxie Docs?

Todo plano do Moxie Docs inclui um servidor MCP (Model Context Protocol). Agentes e editores compatíveis consultam documentação atual, convenções, comandos verificados e lacunas abertas em vez de adivinhar a partir de leituras parciais de arquivos, o que reduz desperdício de tokens e suposições erradas de API.

O que é um servidor MCP para bases de código?

Um servidor MCP para bases de código expõe documentação e convenções de repositórios a agentes de IA por meio do Model Context Protocol. O Moxie Docs publica um em /api/mcp com acesso via OAuth e token de portador, para que agentes consultem contexto vivo e citado sobre como seu projeto realmente funciona.

O que acontece quando um agente encontra código não documentado via MCP?

As ferramentas MCP retornam lacunas estruturadas e impacto, não APIs inventadas. Os agentes podem chamar moxie.get_doc_gaps, moxie.get_doc_impact e moxie.propose_doc_update para que a documentação ausente entre no mesmo PR da mudança de código — ou aguardar a Limpeza de Sexta-feira — em vez de mascarar o problema.

E se a documentação estiver certa e o código estiver errado?

A detecção de desvios trata a base de código atual como o sinal principal do que foi entregue. O Moxie nunca reescreve automaticamente código de aplicação nem sobrescreve silenciosamente intenções escritas por humanos. PRs apenas de documentação permanecem revisáveis — se um merge ruim quebrou o código, rejeite a mudança de documentação e corrija o código. RFCs voltados para o futuro não são tratados como obsoletos apenas porque citam caminhos que ainda não foram construídos.

Como o Moxie lida com RFCs e documentos de design antes do código?

Documentos escritos por humanos e voltados para o futuro são protegidos contra falsa obsolescência de "apague isto". Citações que nunca existiram em um índice anterior são rastreadas como nunca construídas, não como remoções. Quando essas referências começam a resolver para código real, o Moxie emite um sinal informativo de pronto-para-verificar para humanos — ele não faz merge automático nem reescreve o RFC. Documentos manuais desatualizados, mas ainda válidos, podem ser atualizados via PRs revisáveis.

Notas internas podem vazar para a base de conhecimento pública?

Nenhuma página vai ao público sem uma etapa humana de publicação. A caixa de entrada de revisão da Base de Conhecimento Pública mantém rascunhos privados; documentos do espaço de trabalho voltados a agentes e notas temporárias de implementação não fazem parte do site público. Portões de qualidade sinalizam jargão interno e frases propensas a vazamento antes da publicação. Você escolhe o público (usuários, desenvolvedores ou ambos) na configuração.

Como a indexação funciona em grandes monorepos com commits frequentes?

O primeiro índice é uma linha de base completa e leva mais tempo em árvores grandes. Depois disso, merges reverificam a superfície afetada de forma incremental, para que cada commit não seja uma reconstrução completa. Use caminhos ignorados nas configurações de documentação do repositório para pular pastas geradas, dependências de terceiros e ruído. Planos Team têm indexação prioritária para frotas maiores.

Como torno as verificações de PR do Moxie Docs obrigatórias antes do merge?

Na proteção de branch do GitHub (ou rulesets), exija verificações de status e selecione Moxie Docs / Description, Moxie Docs / Documentation e/ou Moxie Docs / Conventions. Até você fazer isso, o Moxie publica execuções de verificação consultivas para que os achados permaneçam visíveis sem bloquear a equipe por padrão.

Como o Moxie Docs ajuda a integrar novos engenheiros?

O Moxie gera visões gerais pesquisáveis de arquitetura, guias de módulos e guias de convenções citados aos arquivos-fonte e os mantém atualizados a cada merge. Novos engenheiros pesquisam um único espaço de trabalho em vez de explorar o repositório, e os agentes de IA que usam herdam o mesmo contexto fundamentado via MCP.

O Moxie Docs pode gerar documentação de arquitetura a partir do código-fonte?

Sim. O Moxie indexa seu repositório, cria um esboço de módulos e dependências e gera páginas de arquitetura, referências e resumos de convenções com citações aos arquivos de origem. As páginas são regeneradas incrementalmente quando o código subjacente muda.

O que é uma base de conhecimento hospedada?

Uma base de conhecimento hospedada é um site de ajuda pesquisável fundamentado na sua base de código — escrito para os usuários finais do seu produto, para desenvolvedores que integram sua API ou ambos, dependendo do público escolhido na configuração. O Moxie Docs a publica em um subdomínio moxiedocs.app (domínios personalizados em breve nos planos Pro e Team) com revisão humana antes de qualquer publicação, busca integrada de artigos e conteúdo que permanece no seu repositório git como Markdown.

O Moxie Docs pode hospedar uma central de ajuda para usuários finais?

Sim. Escolha o público "Usuário" durante a configuração da base de conhecimento e o Moxie escreve artigos de ajuda em linguagem simples sobre como usar seu produto — sem identificadores de código ou jargão interno — revisados por você antes de qualquer publicação. Escolha "Ambos" para atender usuários finais e desenvolvedores no mesmo site.

O Moxie Docs alterará meu código de aplicação automaticamente?

Não. O Moxie apenas propõe mudanças de documentação como pull requests revisáveis. O alinhamento de descrição pode atualizar a descrição de um pull request no GitHub, mas seu código-fonte, proteção de branch e controles de merge permanecem com sua equipe.

Ferramentas

  • Central de ferramentas gratuitas: Todos os utilitários de documentação baseados em navegador em um só lugar.
  • Editor de Diagramas Mermaid: Editor privado no navegador com pré-visualização instantânea, URLs compartilháveis e exportação em SVG.
  • SQL para Diagrama ER: Cole o SQL de CREATE TABLE para um diagrama ER Mermaid ao vivo, exportação em SVG/PNG e documentação opcional de modelo de dados com IA.
  • Gerador de README: Construtor estruturado de README com pré-visualização Markdown ao vivo e exportação compartilhável.
  • Gerador de llms.txt: Importe um sitemap, edite com pré-visualização ao vivo e exporte um llms.txt válido para agentes de IA.
  • Gerador de AGENTS.md: Construtor estruturado de AGENTS.md com pré-visualização ao vivo, exemplos e exportação compartilhável para agentes de codificação.
  • Gerador de ADR: Registros de Decisão de Arquitetura orientados por formulário, com exemplos e exportação Markdown limpa.
  • Validador de llms.txt: Cole ou envie um llms.txt para validar estrutura, links e posicionamento da seção opcional.
  • Gerador de .cursorrules: Elabore regras do Cursor (.cursorrules) com diretrizes estruturadas, pré-visualização ao vivo e exportação em Markdown.
  • Gerador de CLAUDE.md: Gerador estruturado de arquivo CLAUDE.md para Claude Code, com comandos, convenções e exportação.
  • Gerador de .windsurfrules: Elabore regras do Windsurf (.windsurfrules) com diretrizes estruturadas, pré-visualização ao vivo e exportação em Markdown.

Legal

Opcional