Skip to content

fix: make doctor command findings actionable - #432

Merged
Kinfe123 merged 3 commits into
mainfrom
fix/doctor-actionable-findings
Aug 3, 2026
Merged

fix: make doctor command findings actionable#432
Kinfe123 merged 3 commits into
mainfrom
fix/doctor-actionable-findings

Conversation

@Kinfe123

@Kinfe123 Kinfe123 commented Aug 3, 2026

Copy link
Copy Markdown
Member

Summary

  • attach actionable command findings to the doctor command-health check in text and JSON output
  • preserve exact source lines for frontmatter commands and individual shell-fence commands
  • add docs doctor --ci GitHub annotations with file, line, command, reason, and proposed correction while keeping JSON stdout parseable
  • recognize the valid docs skills scaffold command so the website no longer reports three false positives

Root cause

The usefulness analyzer already retained most command failure context, but doctor reduced it to aggregate counts. Contract commands also lacked source positions, fenced commands used the opening-fence line, and the static docs CLI registry had not been updated for skills scaffold.

Validation

  • pnpm --filter @farming-labs/docs test — 1,334 tests passed
  • pnpm typecheck
  • pnpm format:check
  • pnpm lint — passes with existing unrelated warnings
  • website dogfood: command health improved from 320/323 to 323/323

Summary by cubic

Make doctor command-health findings actionable with exact file/line locations and proposed corrections across text, JSON, and GitHub Actions annotations. Adds --ci and --json-output to keep annotations and JSON output separate without mixing streams.

  • New Features

    • Attach actionable findings to the command-health check in text and JSON (file, line, command, reason, proposedCorrection).
    • Preserve exact source lines for frontmatter and fenced shell commands, including \ continuations and console prompts; ignore human-only blocks without shifting line numbers.
    • Add docs doctor --ci to emit GitHub workflow annotations on stdout, and --json-output <path> to write the JSON report; disallow --ci with --json to avoid stdout collisions.
  • Bug Fixes

    • Recognize docs skills scaffold as a valid CLI subcommand to stop false positives.

Written for commit 3f74171. Summary will update on new commits.

Review in cubic

@vercel

vercel Bot commented Aug 3, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs-website Ready Ready Preview Aug 3, 2026 12:49pm
farming-labs-docs-docs-cloud Building Building Preview Aug 3, 2026 12:49pm

Request Review

@pkg-pr-new

pkg-pr-new Bot commented Aug 3, 2026

Copy link
Copy Markdown

Open in StackBlitz

@farming-labs/astro

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/astro@432

@farming-labs/astro-theme

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/astro-theme@432

@farming-labs/docs

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/docs@432

@farming-labs/theme

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/theme@432

@farming-labs/next

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/next@432

@farming-labs/nuxt

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/nuxt@432

@farming-labs/nuxt-theme

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/nuxt-theme@432

@farming-labs/svelte

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/svelte@432

@farming-labs/svelte-theme

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/svelte-theme@432

@farming-labs/tanstack-start

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/tanstack-start@432

commit: 3f74171

@greptile-apps greptile-apps Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Your trial has ended. Reactivate Greptile to resume code reviews.

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

All reported issues were addressed across 5 files

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread packages/docs/src/cli/doctor.ts Outdated
Comment thread packages/docs/src/agent-usefulness.ts Outdated

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

All reported issues were addressed across 1 file (changes from recent commits).

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread packages/docs/src/cli/doctor.test.ts Outdated
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.

1 participant