[rig-sampler] docs(rig): add JSDoc to all AgentSpec fields - #36
Merged
Conversation
Document model, maxTurns, addons, agents, systemMessage, tools, input, output, instructions, and name — clarifying defaults and usage intent for each option. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Collaborator
|
@copilot do not use gpt-4.1 as example it's deprecated. |
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Contributor
Replaced |
Collaborator
|
@copilot do not use o models, use gpt-5* level models |
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Contributor
Replaced |
Contributor
Author
|
🧠 Matt Pocock Skills Reviewer has completed the skills-based review. ✅ |
Contributor
Author
There was a problem hiding this comment.
Skills-Based Review 🧠
Applied /grill-with-docs — no blocking issues. The JSDoc additions are accurate and complete.
📋 Key Themes & Highlights
Positive Highlights
- ✅ All ten
AgentSpecfields documented - ✅ Default values (
"gpt-4.1",4,s.string,"agent") verified against the implementation - ✅
modelcomment gives concrete example identifiers ("mini","gpt-5","claude-sonnet") - ✅
outputcomment notes the harness validates and retries — useful context for new users - ✅ Documentation-only change; no behavioral risk
🧠 Reviewed using Matt Pocock's skills by Matt Pocock Skills Reviewer · sonnet46 20.6 AIC · ⌖ 4.98 AIC · ⊞ 6.3K
Comment /matt to run again
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Sample run
Ran
src/samples/15-api-diff-summary.tsthrough the stub runner (RIG_SAMPLE=15 npm run sample).Result: Succeeded in 1 turn — no repair loops. The stub emitted the full rendered prompt, which showed the agent spec clearly:
{ "model": "mini", "output": { "category": "s.enum(...)", "entry": "s.string" }, "instructions": "Convert the change description to Keep a Changelog style." }What the run revealed
While the sample itself ran cleanly, reading the rendered prompt alongside the
AgentSpectype definition highlighted a usability gap: theAgentSpectype has no JSDoc on any of its fields. A developer writing a new agent must infer from context whatmodel,maxTurns,addons,agents,systemMessage, andtoolseach do — and what the defaults are.For example,
model: "mini"appears in the sample but the type signature gives no hint about what model identifiers are accepted or what the default fallback is ("gpt-4.1"). Similarly,maxTurnshas no documented default (4) andaddonshas no indication of built-in options likerepairorsteering.Change
Added JSDoc comments to all ten
AgentSpecfields documenting:model→"gpt-4.1",maxTurns→4,input/output→s.string)modelNo behavior change — documentation only. All 141 tests pass.