Skip to content

chore: update CLI help docs#206

Merged
jy-tan merged 2 commits intomainfrom
update-help-docs
Mar 23, 2026
Merged

chore: update CLI help docs#206
jy-tan merged 2 commits intomainfrom
update-help-docs

Conversation

@jy-tan
Copy link
Contributor

@jy-tan jy-tan commented Mar 23, 2026

No description provided.

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

2 issues found across 13 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="cmd/short_docs/unit/overview.md">

<violation number="1" location="cmd/short_docs/unit/overview.md:5">
P3: The docs overstate output format: not all `tusk unit` invocations return JSON (the base command/help renders markdown text). Clarify this to avoid misleading scripting users.</violation>
</file>

<file name="cmd/short_docs/drift/drift_overview.md">

<violation number="1" location="cmd/short_docs/drift/drift_overview.md:17">
P3: Fix the sentence grammar: use "wait for it to be ready" for clarity in this user-facing help doc.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

@jy-tan jy-tan merged commit da54638 into main Mar 23, 2026
13 checks passed
@jy-tan jy-tan deleted the update-help-docs branch March 23, 2026 19:26
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.

2 participants