Skip to content

docs: simplify README installation, expand dev setup with all config options#163

Merged
ichoosetoaccept merged 2 commits intomainfrom
02-16-docs_simplify_readme_installation_expand_dev_setup_with_all_config_options
Feb 16, 2026
Merged

docs: simplify README installation, expand dev setup with all config options#163
ichoosetoaccept merged 2 commits intomainfrom
02-16-docs_simplify_readme_installation_expand_dev_setup_with_all_config_options

Conversation

@ichoosetoaccept
Copy link
Member

@ichoosetoaccept ichoosetoaccept commented Feb 16, 2026

Summary

Simplifies the README MCP client configuration section from 5 per-client snippets (Windsurf, Claude Desktop, Cursor, Other clients, generic) down to one generic JSON snippet. Developers using any MCP client can figure out where to put it.

Changes

  • Collapsed installation: Single JSON config snippet replaces per-client sections (Windsurf, Claude Desktop, Cursor, "Other clients")
  • Expanded dev setup: uv run --directory snippet with all CRB_* env vars enabled and commented, explaining that local source changes take effect on server restart
  • Removed redundant config example: Configuration section now references the dev setup instead of duplicating the JSON
  • Net -87 lines: 22 added, 109 removed

Why

Someone experienced enough to use an MCP server will figure out where their client stores config JSON. We only need to provide the correct JSON shape.

Copy link
Member Author

ichoosetoaccept commented Feb 16, 2026

@greptile-apps
Copy link

greptile-apps bot commented Feb 16, 2026

Greptile Summary

Consolidates MCP client installation from 5 separate per-client sections into a single generic JSON snippet, assuming developers can locate their client's config file. Expands the dev setup section with a fully-commented jsonc example showing all available CRB_* environment variables. Removes redundant config examples from the Configuration section and links back to the dev setup instead. Clean documentation refactor that reduces verbosity while improving clarity.

Confidence Score: 5/5

  • This PR is safe to merge with minimal risk
  • Pure documentation refactor with no code changes. Simplifies installation instructions while improving clarity and reducing duplication. The consolidated approach is more maintainable and assumes reasonable technical competence from users.
  • No files require special attention

Important Files Changed

Filename Overview
README.md Documentation improvements: consolidated MCP client config from 5 sections to 1, expanded dev setup with all config options, removed redundant examples. Net -87 lines.

Last reviewed commit: 3d495de

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

Copy link
Member Author

ichoosetoaccept commented Feb 16, 2026

Merge activity

  • Feb 16, 11:54 AM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Feb 16, 11:54 AM UTC: @ichoosetoaccept merged this pull request with Graphite.

@ichoosetoaccept ichoosetoaccept merged commit 20b15b4 into main Feb 16, 2026
7 checks passed
@ichoosetoaccept ichoosetoaccept deleted the 02-16-docs_simplify_readme_installation_expand_dev_setup_with_all_config_options branch February 16, 2026 11:54
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