docs: sync README CLI help output with actual CLI

[btea]

The help text in the README had drifted from the actual CLI:

• add missing --log-level option to the main command help
• add missing generate options: --config-file, --chunk-size, --index, --minify, --type-map, and the updated -t/--target description (including sitemap, web, and custom generator specifiers)
• make --ignore a required variadic glob argument
• drop stale hardcoded defaults for --threads, --version, --changelog, and --git-ref, which are now resolved via configuration

Description

Validation

Related Issues

Check List

• I have read the Contributing Guidelines and made commit messages that follow the guideline.
• I have run node --run test and all tests passed.
• I have check code formatting with node --run format:check & node --run lint.
• I've covered new added functionality with unit tests if necessary.

[vercel]

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

Project	Deployment	Actions	Updated (UTC)
api-docs-tooling	Ready	Preview	Aug 2, 2026 7:50am

[cursor]

PR Summary

Low Risk
Documentation-only README changes plus a minor Commander option metadata fix with no runtime behavior change beyond correct --git-ref parsing/help.

Overview
README now mirrors the live @node-core/doc-kit help: root --log-level, expanded generate flags (--config-file, --chunk-size, --index, --minify, --type-map), updated -t/--target text (including sitemap, web, and custom generators), and descriptions without stale baked-in defaults for threads/version/changelog/git-ref.

generate command fixes --git-ref so Commander documents it as --git-ref <ref> with description “Git ref” instead of a broken --git-ref “Git ref URL” option.

^{Reviewed by Cursor Bugbot for commit 1792f92. Bugbot is set up for automated code reviews on this repo. Configure here.}

[codecov]

Codecov Report

❌ Patch coverage is 0% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 89.12%. Comparing base (3ca6de5) to head (1792f92).

Files with missing lines	Patch %	Lines
packages/core/bin/commands/generate.mjs	0.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #984   +/-   ##
=======================================
  Coverage   89.12%   89.12%           
=======================================
  Files         196      196           
  Lines       18083    18083           
  Branches     1667     1667           
=======================================
  Hits        16116    16116           
  Misses       1960     1960           
  Partials        7        7           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[Copilot]

Pull request overview

This PR updates the README’s embedded CLI --help output so it reflects the current @node-core/doc-kit CLI options and generate subcommand flags, reducing documentation drift for end users.

Changes:

• Adds the missing top-level --log-level option to the README help snippet.
• Updates generate --help output in the README with newly supported options (--config-file, --chunk-size, --index, --minify, --type-map) and an updated --target description (including sitemap, web, and custom generator specifiers).
• Adjusts --ignore to be shown as a required variadic glob argument and removes stale hardcoded defaults for several options.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 1 out of 2 changed files in this pull request and generated no new comments.