Skip to content

Improve README.md#66

Merged
satvik007 merged 4 commits intomainfrom
dev/ram/improve-readme
May 5, 2026
Merged

Improve README.md#66
satvik007 merged 4 commits intomainfrom
dev/ram/improve-readme

Conversation

@ramilamparo
Copy link
Copy Markdown
Collaborator

@ramilamparo ramilamparo commented May 4, 2026

Highlights public API commands, and agentic workflows.

@claude
Copy link
Copy Markdown

claude Bot commented May 4, 2026

Claude finished @ramilamparo's task in 4m 23s —— View job


Review of PR #66: Improve README.md

  • Gather PR context and diff
  • Launch specialized review subagents
  • Aggregate findings and post review
  • Clean up outdated bot comments

The rewritten Description and new Example Workflows section are a clear improvement — concrete bash examples and structured use-case bullets make the tool much more approachable. Three inline comments posted on specific lines:

  1. Broken SKILL.md link (line 36) — ./SKILL.md doesn't exist in the repo
  2. --body vs --items (line 50) — --items would be more consistent with the API Command Tree
  3. statusCounts in jq example (line 59) — field isn't in the typed Run interface; worth confirming against the live API

No security, performance, or test coverage concerns (documentation-only change).

claude[bot]

This comment was marked as outdated.

@claude
Copy link
Copy Markdown

claude Bot commented May 4, 2026

Claude finished @ramilamparo's task in 5m 48s —— View job


Review of PR #66: Improve README.md

  • Gather PR context and diff
  • Launch specialized review subagents
  • Aggregate findings and post review
  • Clean up outdated bot comments

The rewritten Description and new Example Workflows section are a solid improvement. Two new inline comments posted (lines 46 and 58) on top of the three from the prior review:

  1. {YYYY}-{MM}-{DD} template won't expandapi runs create passes --title as-is; use $(date +%Y-%m-%d) instead
  2. --closed false yargs quirk — yargs boolean treats this as --closed (true) + positional; use --no-closed
  3. (prior) Broken SKILL.md link — file is at skills/qas-cli/SKILL.md, not ./SKILL.md
  4. (prior) --body vs --items style choice on batch-create
  5. (prior) statusCounts not in typed Run interface — confirm against live API

No security, performance, or test coverage concerns.

claude[bot]

This comment was marked as outdated.

@claude
Copy link
Copy Markdown

claude Bot commented May 4, 2026

Claude finished @ramilamparo's task in 7m 27s —— View job


Review of PR #66: Improve README.md

  • Gather PR context and diff
  • Launch specialized review subagents
  • Aggregate findings and post review
  • Clean up outdated bot comments

Three of five items from previous reviews are now fixed (SKILL.md link, --items usage, $(date) substitution). One new inline comment posted, plus one existing thread still open:

  1. --closed false yargs quirk (line 58) — re-raised; --no-closed is the correct form
  2. statusCounts not in typed Run interface (line 59) — existing thread; worth confirming the field exists in the live API response

Resolved two outdated bot threads (SKILL.md link, --body vs --items) and minimized two older bot review summaries. No security, performance, or test coverage concerns.

Copy link
Copy Markdown

@claude claude Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good progress — three of the five items from previous reviews are now fixed (SKILL.md link, --items usage, $(date) instead of {YYYY}). Two items remain:

  1. --closed false (line 58) — re-raised inline; yargs boolean quirk means this filters for closed runs, not open ones
  2. statusCounts (line 59) — existing thread still open; the field isn't in the typed Run interface, so it's worth confirming it's present in the actual API response before documenting it

No security, performance, or test coverage concerns.

Comment thread README.md
Copy link
Copy Markdown
Contributor

@hi-rai hi-rai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks okay. Unrelated, but I guess now we can also add a link to the CLI in our API docs

@ramilamparo
Copy link
Copy Markdown
Collaborator Author

Looks okay. Unrelated, but I guess now we can also add a link to the CLI in our API docs

I created a separate issue for this.

@satvik007 satvik007 merged commit 01b8fd2 into main May 5, 2026
6 checks passed
@satvik007 satvik007 deleted the dev/ram/improve-readme branch May 5, 2026 13:22
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.

3 participants