Skip to content

Align CLI README with current workflow#169

Closed
jonathanpopham wants to merge 1 commit intosupermodeltools:mainfrom
jonathanpopham:docs/readme-cli-reality-apr30
Closed

Align CLI README with current workflow#169
jonathanpopham wants to merge 1 commit intosupermodeltools:mainfrom
jonathanpopham:docs/readme-cli-reality-apr30

Conversation

@jonathanpopham
Copy link
Copy Markdown
Contributor

@jonathanpopham jonathanpopham commented Apr 30, 2026

Summary

  • align README and npm README around the current bare supermodel watcher-first flow
  • replace stale .graph wording with .graph.* shard wording
  • remove dead Homebrew install command and update docs links/config key

Verification

  • go run . --help
  • go run . analyze --help && go run . restore --help && go run . update --help
  • go test ./cmd
  • npm test --prefix npm
  • stale-reference scan for supermodel watch, --three-file, install.sh, old docs link, Homebrew command, and SUPERMODEL_FILES

Summary by CodeRabbit

Release Notes

  • Documentation
    • Updated file naming convention to .graph.* sidecars across documentation
    • Configuration option changed from files to shards for controlling graph file writing
    • Revised CLI documentation with updated quickstart references
    • Streamlined usage examples and added one-off analysis example

@jonathanpopham
Copy link
Copy Markdown
Contributor Author

Closing per request.

@jonathanpopham jonathanpopham deleted the docs/readme-cli-reality-apr30 branch April 30, 2026 23:33
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 30, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 08c6436a-e1f6-4f94-8041-4eca98dff3df

📥 Commits

Reviewing files that changed from the base of the PR and between 4ee130f and 16bf876.

📒 Files selected for processing (2)
  • README.md
  • npm/README.md

Walkthrough

Documentation updates across two README files to reflect the new .graph.* sidecar file naming convention, reconfigure config option naming from files to shards, update CLI documentation links, and clarify command usage patterns.

Changes

Cohort / File(s) Summary
Primary README Updates
README.md
Replaces .graph file references with .graph.* sidecars; updates CLI docs link from /cli/install to /cli/quickstart; removes macOS Homebrew section; changes configuration from files/SUPERMODEL_FILES to shards/SUPERMODEL_SHARDS.
NPM Package README
npm/README.md
Describes .graph.* sidecar files as the output format; consolidates usage examples by removing separate "generate" vs "watch" sections; adds explicit "one-off analysis" example using supermodel analyze; clarifies supermodel as the primary command.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • greynewell

Poem

📚 The docs take flight, sidecar sidecars now shine bright,
Shards replace files, .graph.* in the night,
Quickstart links gleam, one command supreme,
README's refactored—a cleaner dev dream! ✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Review rate limit: 0/5 reviews remaining, refill in 48 minutes and 1 second.

Comment @coderabbitai help to get the list of available commands and usage tips.

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