Link to CLI docs from README#147
Conversation
Adds the new docs.supermodeltools.com/cli home as a prominent link near the top of the README and as a row in the Links table. The docs cover install, file mode, agent integration, configuration, and a full command reference — see supermodeltools/docs#7.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
WalkthroughThe README.md was updated to add direct links to the full CLI documentation in two places: a new standalone “Full CLI docs” line near the top and an additional “CLI Docs” entry in the Links table. No functional code or exported entities were changed. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Review rate limit: 2/5 reviews remaining, refill in 29 minutes and 59 seconds. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
README.md (1)
245-245: Minor UX nit: keep the link label wording consistent.Top callout uses “Full CLI docs” (Line 7), while the Links table row uses “CLI Docs” (Line 245). Consider using the same label in both places (either “CLI Docs” everywhere or “Full CLI docs” everywhere) to reduce cognitive friction.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 245, The README has inconsistent link label wording: the top callout uses "Full CLI docs" while the Links table uses "CLI Docs" (the table entry linking to https://docs.supermodeltools.com/cli/overview). Update the table row label (or the top callout) so both labels match exactly—e.g., change the table's "CLI Docs" to "Full CLI docs" (or change the top callout to "CLI Docs")—and ensure the link target remains https://docs.supermodeltools.com/cli/overview.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@README.md`:
- Line 245: The README has inconsistent link label wording: the top callout uses
"Full CLI docs" while the Links table uses "CLI Docs" (the table entry linking
to https://docs.supermodeltools.com/cli/overview). Update the table row label
(or the top callout) so both labels match exactly—e.g., change the table's "CLI
Docs" to "Full CLI docs" (or change the top callout to "CLI Docs")—and ensure
the link target remains https://docs.supermodeltools.com/cli/overview.
1 participant
Summary
docs.supermodeltools.com/cli/overview) near the top of the READMECompanion PR on the docs repo: supermodeltools/docs#7
Test plan
Summary by CodeRabbit