Skip to content

docs: add llms.txt, AGENTS.md and CLAUDE.md - #34

Merged
lpsm-dev merged 1 commit into
mainfrom
claude/agent-docs
Jul 16, 2026
Merged

docs: add llms.txt, AGENTS.md and CLAUDE.md#34
lpsm-dev merged 1 commit into
mainfrom
claude/agent-docs

Conversation

@lpsm-dev

Copy link
Copy Markdown
Owner

Adiciona os três arquivos de contexto para agentes/LLMs solicitados.

Arquivos

  • AGENTS.md - guia voltado a máquinas (contraparte do CONTRIBUTING.md): layout do projeto, comandos reais de build/test/lint (extraídos do Taskfile), e as regras rígidas: CC ≤ 10 (gocyclo), âncoras github-slugger, cuidado com module path de major bumps v2+ (charm.land/*/v2), Conventional Commits e definition of done.
  • CLAUDE.md - importa o AGENTS.md via @AGENTS.md (sintaxe de import do Claude Code) e adiciona notas específicas do Claude, evitando duplicação.
  • llms.txt - no formato do llmstxt.org: resumo do projeto, referência dos subcomandos com flags, e links para docs e código-fonte (apontando o internal/generator/generator.go como ponto de partida).

Observação sobre os outros dois pedidos

Os outros dois itens que você mencionou já existem no CLI:

  1. Enumerar # ## ### + back-to-top ao fim de cada #: coberto por gtoc generate (enumera os headings num TOC com âncoras acentuadas) + gtoc analyze (insere o "back to top" ao fim de cada seção #).
  2. Auto-update a partir das releases do GitHub: é o gtoc upgrade (reescrito nesta série de PRs: comparação semver numérica, seleção do asset pela API do GitHub, verificação de checksum SHA-256 e extração pure-Go).

Sem código Go alterado - só documentação.

Co-Authored-By: Claude noreply@anthropic.com

- AGENTS.md: machine-facing contributor guide (layout, build/test/lint
  commands, hard constraints: CC<=10, github-slugger anchors, v2 module
  path caveat, conventional commits, definition of done)
- CLAUDE.md: imports AGENTS.md via @AGENTS.md plus Claude-specific notes
- llms.txt: llmstxt.org-format project summary with command reference and
  links to docs and source

Co-Authored-By: Claude <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@lpsm-dev, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 37 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 37e97bb1-be70-48a4-80b8-edfb5b5cfdd3

📥 Commits

Reviewing files that changed from the base of the PR and between aca4373 and 9f2596f.

📒 Files selected for processing (3)
  • AGENTS.md
  • CLAUDE.md
  • llms.txt
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/agent-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@lpsm-dev
lpsm-dev merged commit f0f2a74 into main Jul 16, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant