Skip to content

Add CLI graph files explainer#14

Merged
jonathanpopham merged 1 commit intomainfrom
docs/cli-graph-files-explainer
Apr 30, 2026
Merged

Add CLI graph files explainer#14
jonathanpopham merged 1 commit intomainfrom
docs/cli-graph-files-explainer

Conversation

@jonathanpopham
Copy link
Copy Markdown
Collaborator

@jonathanpopham jonathanpopham commented Apr 30, 2026

Summary

  • add a CLI graph files concept page explaining .graph.* sidecars
  • cover watcher vs one-shot analysis, cache freshness, clean, and agent read flow
  • add the page to the CLI Get started navigation

Verification

  • jq empty docs.json
  • stale-reference scan for install.sh, supermodel watch, --three-file, SUPERMODEL_FILES, and files: true

Summary by CodeRabbit

  • Documentation
    • Added comprehensive guide for Graph Files feature, explaining how Supermodel generates dependency maps and call relationships for AI agents
    • Includes configuration options, watcher modes, and cleanup procedures

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 30, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2acb9216-a16a-4565-98b4-dce17c1e8bde

📥 Commits

Reviewing files that changed from the base of the PR and between 50b581d and f948c3f.

📒 Files selected for processing (2)
  • cli/graph-files.mdx
  • docs.json

Walkthrough

A new documentation page explains Supermodel's .graph.* sidecar files—precomputed dependency and call relationship maps generated during watching. Documents the recommended watcher-first workflow, agent integration instructions, CLI options like --no-shards and --force, and cleanup commands. Updates docs.json navigation accordingly.

Changes

Cohort / File(s) Summary
Documentation Content
cli/graph-files.mdx
New MDX page explaining .graph.* sidecars, recommended watcher workflow, agent integration guidance (reading graph files before implementation), CLI behaviors (supermodel vs supermodel analyze), options (--no-shards, --force), and cleanup commands.
Documentation Navigation
docs.json
Appends cli/graph-files page to the CLI "Get started" group to surface the new documentation in navigation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

📋 A map appears beside each file,
Dependencies laid out in perfect style—
Your agent reads before it starts,
A precomputed graph of interconnected parts. ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding a new CLI documentation page explaining graph files, which matches the primary content additions in the PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/cli-graph-files-explainer

Review rate limit: 1/5 review remaining, refill in 46 minutes and 36 seconds.

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

@jonathanpopham jonathanpopham merged commit 76271a0 into main Apr 30, 2026
3 checks passed
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