automaintainer: Improve supercli static documentation: README, CONTRIBUTING…

[javimosch]

Automated maintenance run by automaintainer.

Focus: Improve supercli static documentation: README, CONTRIBUTING, or docs/ files. Make ONE atomic commit with clear summary explaining what documentation was improved and WHY. Use fix:/docs: prefix. Keep it focused and reviewable.

Branch: am/am-f17c27-tgarum

Summary

Improved supercli static documentation by fixing three inconsistencies and gaps. Added lint and typecheck commands to CONTRIBUTING.md's Quick Development Commands table since AGENTS.md emphasizes these as pre-commit checks. Fixed confusing troubleshooting entries in README.md about JSON output where the flowchart suggested adding --json flag when JSON is already the default. Updated docs/AGENTS_FRIENDLY_TOOLS.md to replace bdg references with supercli since the file was copied from another project and not adapted for supercli context.

Diff:

CONTRIBUTING.md               |  2 ++
 README.md                     |  4 ++--
 docs/AGENTS_FRIENDLY_TOOLS.md | 44 +++++++++++++++++++++----------------------
 3 files changed, 26 insertions(+), 24 deletions(-)

Summary by CodeRabbit

• Documentation
  • Added common development commands (lint and typecheck) to contributor guide.
  • Enhanced JSON output troubleshooting guidance with improved diagnostic steps.
  • Updated tool naming and branding consistency across documentation.

[chatgpt-codex-connector]

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

[chatgpt-codex-connector]

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 12bdcc53-df99-4d94-91d4-0405bdde081a

📥 Commits

Reviewing files that changed from the base of the PR and between 58f6429 and e6fb9ae.

📒 Files selected for processing (3)

• CONTRIBUTING.md
• README.md
• docs/AGENTS_FRIENDLY_TOOLS.md

---

📝 Walkthrough

Walkthrough

Documentation updates across three files: CONTRIBUTING.md adds developer command entries (npm lint, npm typecheck), README.md corrects JSON troubleshooting guidance to recommend supercli inspect checks instead of --json flag, and AGENTS_FRIENDLY_TOOLS.md systematically replaces tool name bdg with sc throughout examples and design sections.

Changes

Documentation Updates and Tool Naming Consistency

Layer / File(s)	Summary
Developer command documentation CONTRIBUTING.md	Quick Development Commands table expanded with npm run lint and npm run typecheck entries.
README troubleshooting guidance refinement README.md	"Output is not JSON" troubleshooting row and diagnostic flowchart updated to recommend supercli inspect <ns> <res> <act> for JSON support verification instead of --json flag.
Tool naming and branding consistency in AGENTS_FRIENDLY_TOOLS.md docs/AGENTS_FRIENDLY_TOOLS.md	All bdg command references replaced with sc across structured output, error-suggestion, retry patterns, Unix philosophy, schema introspection, and CLI advantages examples. Design Decision section and Conclusion updated from "bdg" to "supercli" branding.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

• javimosch/supercli#188: Modifies CONTRIBUTING.md's Quick Development Commands section for npm lint/typecheck instructions.
• javimosch/supercli#189: Adjusts CONTRIBUTING.md's Quick Development Commands for npm lint/typecheck vs npm test.
• javimosch/supercli#190: Updates README.md troubleshooting guidance for "output not JSON" diagnostic via supercli inspect vs --json.

Poem

🐰 A rabbit's ode to cleaner docs:

From bdg to sc, the tools align,
Troubleshooting paths now shine and refine,
Commands flow clearly for devs to find,
Documentation renewed, one branch at a time! 📚✨

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch am/am-f17c27-tgarum

---

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 and usage tips.}