Make q2 agents-info more agent-friendly
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 48/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- rust
- Domain
- cli, developer-experience
Research direction
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.
Written by the indexing model from the issue text.
Description
Some friction I hit using q2 agents-info (0.42.0) from an AI agent:
- The index is mostly error codes.
q2 agents-infoprints ~62 KB (~15k tokens), of which 347 error-reference entries are ~56 KB. Listing the error reference as a single entry (full list behind--listor a flag) would shrink it to ~7 KB. - A bare error code doesn't resolve.
q2 agents-info Q-2-38fails, and the suggestions rankerrors/markdown/Q-2-3.mdabove the exactQ-2-38.md(substring match insuggestions()). - Diagnostics don't point to their page. A render error shows
[Q-2-38] Unclosed Attribute Specifier; a hint likesee: q2 agents-info errors/markdown/Q-2-38.mdwould close the loop. - No search in the CLI. The MCP
docstool can search; the CLI can only list or fetch. Something likeq2 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.
- Dominant language
- Rust
- Stars
- 302
- Forks
- 22
- Avg merge
- 5h 2m
- Merged PRs (30d)
- 213
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from quarto-dev/q2
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
quarto-dev/q2#1219 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
quarto-dev/q2#1188 · 3 comments ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
quarto-dev/q2#1179 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
quarto-dev/q2#1133 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
quarto-dev/q2#1103 · 1 comment ·
Maintainers usually reply within 1 day
Similar issues
-
priority: low
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
storytold/photocraft#15350 ·
Maintainers usually reply within 1 day
-
area:davinci
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
ubugeeei-prod/vize#13167 ·
Maintainers usually reply within 1 day
-
area:ui enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
transit-audio/transit#738 ·
Maintainers usually reply within 1 day
-
enhancement good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 91/100
hocinehacherouf/liberarr#78 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day