Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

docs/AGENTS.md is repo authoring guidance, but everything in docs/ gets published

Aberta Para iniciantes
  • Algo errado?
#2,758 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
1/5
Tempo estimado
Menos de uma hora
Facilidade para iniciantes
85/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Ativa
Domínio
documentation

Direção de pesquisa

A issue é sobre mover um arquivo. O arquivo está atualmente em docs/AGENTS.md. A correção sugerida é movê-lo para .github/instructions/docs-style.instructions.md ou para a raiz do repositório como AGENTS.md. Verifique a estrutura do repositório para ver a localização atual e os diretórios de destino. Verifique se mover o arquivo resolve o problema de sincronização, garantindo que ele esteja fora do diretório docs/, que é sincronizado com o docs.github.com.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

documentation

What changed

In 51a0394 (Update SDK snapshot for Copilot CLI 1.0.88-2), this file was renamed:

.github/instructions/docs-style.instructions.md  ->  docs/AGENTS.md

The content was effectively unchanged (+6/-5). It is still the same thing it was before: authoring guidance for people and agents writing docs in this repo.

Why the new location is a problem

Everything under docs/ is synced into GitHub's docs pipeline and published to docs.github.com — as the file itself states:

These docs are synced to github/docs-internal via a normalization pipeline, so they must follow the conventions below to be compatible with docs.github.com.

That sync copies the whole docs/ directory and excludes only .validation/ and developer-docs/. Its previous home, .github/instructions/, was never in scope. So the rename has two consequences:

1. It becomes a published page. docs/AGENTS.md is on track to render as a public SDK documentation page, where readers would get a contributor style guide ("Only code inside <details> blocks", "Blocks must be consecutive") presented as end-user SDK docs.

2. It stalled the sync. Because the file documents the <details> → tabbed-code-sample convention, its prose necessarily contains many inline `<details>` mentions. Our normalizer treated those as real tags and hung on the file; one sync run had to be cancelled after ~3 hours.

To be clear, (2) is our bug, and it is already fixed — the parser should never have hung on valid Markdown, and it no longer does. This issue is only about (1), which the fix does not address: the file is still slated for publication.

Suggested fix

Move it back out of docs/. Either:

  • .github/instructions/docs-style.instructions.md — its previous home, or
  • repo-root AGENTS.md — where the AGENTS.md convention expects it, and which is outside the synced directory.

Either keeps it discoverable to agents and contributors without publishing it as user-facing documentation.

Linguagem predominante
Java
Estrelas
10.5k
Forks
1.5k
Merge médio
1d 8h
PRs com merge (30d)
111

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de github/copilot-sdk

Todas as issues de github/copilot-sdk

Issues semelhantes

Mais issues de Java

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.