docs: clarify CLI frameworks and generators on the homepage

[jdx]

https://entire.io/gh/jdx/usage/trails/32

Explain that Usage builds command-line interfaces and generates their documentation. Replace broad slogans with headings that distinguish defining a CLI from generating docs, completions, and clients. Keep the Rust, existing-framework, and script entry points, as well as benchmark details and the Go preview notice.

Validation: documentation production build and local homepage links/assets passed; desktop and 390px mobile layouts inspected with no horizontal overflow.

AI-assisted — Tool: Codex; model: OpenAI/unavailable; version: unavailable.

---

Note

Low Risk
Documentation and marketing copy only; no application logic, APIs, or build behavior changes.

Overview
Homepage and hero copy now spell out that Usage both builds CLIs and generates documentation from one definition, instead of shorter slogans like “Define your CLI once” and “The toolkit for command-line interfaces.”

The hero (UsageHero.vue) drops the top label line and rewrites the tagline and body to separate defining the interface (Rust framework or KDL spec) from outputs (completions, reference docs, client libraries). docs/index.md removes the small “section label” lines above the main headings and retitles the two blocks to “Choose how to define your CLI” and “Generate docs, completions, and clients,” with toolkit text that frames generators as driven by the spec and regenerated when the interface changes. Entry paths (Rust, connect existing tool, scripts) and links are unchanged.

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

Summary by CodeRabbit

• Documentation
  • Updated the homepage messaging to describe defining command-line interfaces with a Rust framework and KDL specifications.
  • Clarified that specifications can be used to generate shell completions, reference documentation, and client libraries.

[coderabbitai]

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Advanced

Run ID: db5af7cb-b609-4c8b-a6ef-5e75289356c1

📥 Commits

Reviewing files that changed from the base of the PR and between 13c051e and 4d77509.

📒 Files selected for processing (2)

• docs/.vitepress/theme/UsageHero.vue
• docs/index.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.

---

📝 Walkthrough

Walkthrough

The hero and homepage copy now describes CLI definitions and generated documentation, shell completions, and client libraries. Two label elements were removed.

Changes

Homepage copy

Layer / File(s)	Summary
Hero and homepage messaging docs/.vitepress/theme/UsageHero.vue, docs/index.md	The hero tagline and description now mention Rust and KDL definitions and generated outputs. The homepage headings and toolkit text describe defining a CLI and generating docs, completions, and clients. Two label elements were removed.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to 4d775

The homepage messaging changes have no identified user-facing or operational risk that should block merging.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly describes the homepage documentation changes, including clarification of CLI frameworks and generators.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[greptile-apps]

Confidence Score: 5/5

The documentation-only changes appear safe to merge.

Summary

Clarifies the homepage by separating CLI-definition workflows from generated documentation and tooling.

• Updates the hero copy to describe the Rust and KDL entry points.
• Reframes the workflow cards around defining a CLI.
• Reframes generated outputs around documentation, completions, and clients.

_{Reviews (1) · Last reviewed commit: "docs: clarify CLI frameworks and generat..."}

[github-actions]

Instruction counts

The comparison never ran — an earlier step failed.

_{4d77509d48ae vs 13c051e5f958 · measured on the runner, not pushed to the history.}