Criar Arquivo LLMs.txt a Partir da Estrutura do Repositório

Crie um novo arquivo llms.txt do zero na raiz do repositório, seguindo a especificação oficial do llms.txt em https://llmstxt.org/. 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

Crie um arquivo llms.txt abrangente que sirva como um ponto de entrada para LLMs entenderem e navegarem no repositório de forma eficaz. O arquivo deve estar em conformidade com a especificação llms.txt e ser otimizado para consumo por LLMs, mantendo-se legível por humanos.

Fase de Análise e Planejamento

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

Etapa 1: Revisar a Especificação llms.txt

• Revise a especificação oficial em https://llmstxt.org/ para garantir a conformidade total
• Entenda a estrutura de formato e as diretrizes necessárias
• Observe os requisitos específicos da estrutura markdown

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

• Examine a estrutura completa do repositório usando ferramentas apropriadas
• Identifique o propósito principal e o escopo do repositório
• Catalogue todos os diretórios importantes e seus propósitos
• Liste os arquivos chave que seriam valiosos para o entendimento do LLM

Etapa 3: Descoberta de Conteúdo

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

Etapa 4: Criar Plano de Implementação

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

• Resumo do propósito e escopo do repositório
• Lista em ordem de prioridade de arquivos essenciais para o entendimento do LLM
• Arquivos secundários que fornecem contexto adicional
• Estrutura organizacional para o arquivo llms.txt

Requisitos de Implementação

Conformidade de Formato

O arquivo llms.txt deve seguir esta estrutura exata conforme a especificação:

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

Requisitos de Conteúdo

Elementos Obrigatórios

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

Formato de Link de Arquivo

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

Organização de 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 omitidos 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 build ou conteúdo gerado
• Não sejam relevantes para entender o projeto

Etapas de Execução

Etapa 1: Análise do Repositório

1. Examine completamente a estrutura do repositório
2. Leia o README.md principal para entender o projeto
3. Identifique todos os diretórios e arquivos de documentação
4. Catalogue os arquivos de especificação e seus propósitos
5. Encontre arquivos de exemplo e arquivos de configuração

Etapa 2: Planejamento de Conteúdo

1. Determine a declaração de propósito principal
2. Escreva um resumo conciso para o bloco de citação
3. Agrupe os arquivos identificados em categorias lógicas
4. Priorize os arquivos por importância para o entendimento do LLM
5. Crie descrições para cada link de arquivo

Etapa 3: Criação do Arquivo

1. Crie o arquivo llms.txt na raiz do repositório
2. Siga a especificação de formato exata
3. Inclua todas as seções necessárias

…