Make q2 agents-info more agent-friendly

Aperta
#1,115 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
rust

Direzione di ricerca

Start by locating the q2 agents-info index generation and lookup code, especially suggestions(), then inspect the CLI command definitions for q2 docs and q2 render. The issue describes several possible improvements but does not choose which to implement; agree on scope before changing behavior. Done means the selected CLI improvement works as described and has coverage for its lookup or output behavior.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Some friction I hit using q2 agents-info (0.42.0) from an AI agent:

  1. The index is mostly error codes. q2 agents-info prints ~62 KB (~15k tokens), of which 347 error-reference entries are ~56 KB. Listing the error reference as a single entry (full list behind --list or a flag) would shrink it to ~7 KB.
  2. A bare error code doesn't resolve. q2 agents-info Q-2-38 fails, and the suggestions rank errors/markdown/Q-2-3.md above the exact Q-2-38.md (substring match in suggestions()).
  3. Diagnostics don't point to their page. A render error shows [Q-2-38] Unclosed Attribute Specifier; a hint like see: q2 agents-info errors/markdown/Q-2-38.md would close the loop.
  4. No search in the CLI. The MCP docs tool can search; the CLI can only list or fetch. Something like q2 docs llms --search <terms> would match it.

Smaller: 59 of the 69 non-error pages have no description in the index. Separately, q2 render emits ANSI colours and OSC 8 links when stderr is piped, even with NO_COLOR=1.

Lingua principale
Rust
Stelle
293
Fork
20
Merge medio
5h 38m
PR unite (30g)
199

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di quarto-dev/q2

Tutte le issue di quarto-dev/q2

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.