Atualizar Arquivo LLMs.txt

Atualize o arquivo llms.txt existente na raiz do repositório para refletir as mudanças na documentação, especificações ou estrutura do repositório. Este arquivo fornece orientação de alto nível para modelos de linguagem grandes (LLMs) sobre onde encontrar conteúdo relevante para entender o propósito e as especificações do repositório.

Diretiva Primária

Atualize o arquivo llms.txt existente para manter a precisão e a conformidade com a especificação llms.txt, ao mesmo tempo que reflete a estrutura e o conteúdo atuais do repositório. O arquivo deve permanecer otimizado para consumo por LLMs, mantendo-se legível por humanos.

Fase de Análise e Planejamento

Antes de atualizar o arquivo llms.txt, você deve completar uma análise completa:

Etapa 1: Revisar Arquivo Atual e Especificação

• Leia o arquivo llms.txt existente para entender a estrutura atual
• Revise a especificação oficial em https://llmstxt.org/ para garantir a conformidade contínua
• Identifique áreas que podem precisar de atualizações com base em mudanças no repositório

Etapa 2: Análise da Estrutura do Repositório

• Examine a estrutura atual do repositório usando ferramentas apropriadas
• Compare a estrutura atual com o que está documentado no llms.txt existente
• Identifique novos diretórios, arquivos ou documentação que devem ser incluídos
• Observe quaisquer arquivos removidos ou realocados que precisem ser atualizados

Etapa 3: Descoberta de Conteúdo e Detecção de Mudanças

• Identifique novos arquivos README e suas localizações
• Encontre novos arquivos de documentação (arquivos .md em /docs/, /spec/, etc.)
• Localize novos arquivos de especificação e seus propósitos
• Descubra novos arquivos de configuração e sua relevância
• Encontre novos arquivos de exemplo e amostras de código
• Identifique quaisquer mudanças na estrutura da documentação existente

Etapa 4: Criar Plano de Atualização

Com base em sua análise, crie um plano estruturado que inclua:

• Mudanças necessárias para manter a precisão
• Novos arquivos a serem adicionados ao llms.txt
• Referências desatualizadas a serem removidas ou atualizadas
• Melhorias organizacionais para manter a clareza

Requisitos de Implementação

Conformidade de Formato

O arquivo llms.txt atualizado deve manter esta estrutura exata por especificação:

1. Cabeçalho H1: Linha única com o nome do repositório/projeto (obrigatório)
2. Resumo em Blockquote: Breve descrição em formato de blockquote (opcional, mas recomendado)
3. Detalhes Adicionais: Zero ou mais seções de markdown sem cabeçalhos para contexto
4. Seções de Lista de Arquivos: Zero ou mais seções H2 contendo listas de links em markdown

Requisitos de Conteúdo

Elementos Obrigatórios

• Nome do Projeto: Título claro e descritivo como H1
• Resumo: Blockquote conciso explicando o propósito do repositório
• Arquivos Chave: Arquivos essenciais organizados por categoria (seções H2)

Formato do Link do Arquivo

Cada link de arquivo deve seguir: [descriptive-name](relative-url): optional description

Organização das Seções

Organize os arquivos em seções H2 lógicas, como:

• Documentação: Arquivos de documentação principal
• Especificações: Especificações técnicas e requisitos
• Exemplos: Exemplos de código e de uso
• Configuração: Arquivos de configuração e configuração
• Opcional: Arquivos secundários (significado especial - podem ser ignorados para contexto mais curto)

Diretrizes de Conteúdo

Linguagem e Estilo

• Use linguagem concisa, clara e inequívoca
• Evite jargões sem explicação
• Escreva para leitores humanos e de LLM
• Seja específico e informativo nas descrições

Critérios de Seleção de Arquivos

Inclua arquivos que:

• Expliquem o propósito e o escopo do repositório
• Forneçam documentação técnica essencial
• Mostrem exemplos de uso e padrões
• Definam interfaces e especificações
• Contenham instruções de configuração e configuração

Exclua arquivos que:

• Sejam puramente detalhes de implementação
• Contenham informações redundantes
• Sejam artefatos de compilação ou conteúdo gerado
• Não sejam relevantes para entender o projeto

Etapas de Execução

Etapa 1: Análise do Estado Atual

1. Leia o arquivo llms.txt existente completamente
2. Examine a estrutura atual do repositório completamente
3. Compare as referências de arquivo existentes com o conteúdo real do repositório
4. Identifique referências desatualizadas, ausentes ou incorretas
5. Observe quaisquer problemas estruturais com o arquivo atual

Etapa 2: Planejamento de Conteúdo

1. Determine se a declaração de propósito principal precisa de atualizações
2. Revise e atualize o blockquote de resumo, se necessário
3. Planeje adições para novos arquivos e diretórios
4. Planeje remoções para conteúdo desatualizado ou movido
5. Reorganize seções, se necessário, para melhor clareza

Etapa 3: Atualizações de Arquivo

…