Skip to content

docs: fix inaccuracies in README component table and architecture section#449

Merged
peteski22 merged 1 commit into
mainfrom
fix/readme-accuracy
Jun 19, 2026
Merged

docs: fix inaccuracies in README component table and architecture section#449
peteski22 merged 1 commit into
mainfrom
fix/readme-accuracy

Conversation

@peteski22

@peteski22 peteski22 commented Jun 19, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Plugin release tag prefix: N/Aplugin/X.Y.Z (tags like plugin/0.13.0 exist)
  • CLI published name: github.com/mozilla-ai/cq/cli (Go module path) → cq with Homebrew tap name, matching what users actually type to install
  • Architecture section: removed internal dependency name (mcp-go) — meaningless to readers and couples docs to an implementation detail

Summary by CodeRabbit

Documentation

  • Updated Plugin component release tag prefix information in the published components table.
  • Refined architecture documentation for improved clarity on local server configuration and operation.

…tion

Plugin release tag prefix was listed as N/A but plugin/ tags exist.
CLI published name showed the Go module path instead of the actual
Homebrew/Scoop package name. Architecture section named an internal
dependency (mcp-go) that is meaningless to readers and will rot.
@peteski22 peteski22 merged commit 2017d5d into main Jun 19, 2026
2 checks passed
@peteski22 peteski22 deleted the fix/readme-accuracy branch June 19, 2026 13:22
@coderabbitai

coderabbitai Bot commented Jun 19, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 4da5a862-54f4-4f66-92ba-f3c023b0c349

📥 Commits

Reviewing files that changed from the base of the PR and between 066fb78 and 06ac54d.

📒 Files selected for processing (1)
  • README.md

Walkthrough

Two corrections are made to README.md: the Plugin (Claude Code) entry in the published components table has its "Release tag prefix" updated from N/A to plugin/X.Y.Z, and the Local MCP server architecture bullet removes the explicit mcp-go CLI identifier from its description.

Changes

README Documentation Corrections

Layer / File(s) Summary
Published components table and architecture bullet
README.md
The Plugin (Claude Code) row's "Release tag prefix" changes from N/A to plugin/X.Y.Z, and the Local MCP server architecture bullet removes the explicit mcp-go CLI name from its description.

Possibly related PRs

  • mozilla-ai/cq#441: Adds a plugin/ component tag prefix in scripts/prepare_gitbook_site.py, directly corresponding to the plugin/X.Y.Z release tag prefix now documented for the Plugin (Claude Code) row in this PR.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/readme-accuracy

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

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

javiermtorres pushed a commit that referenced this pull request Jun 22, 2026
…tion (#449)

Plugin release tag prefix was listed as N/A but plugin/ tags exist.
CLI published name showed the Go module path instead of the actual
Homebrew/Scoop package name. Architecture section named an internal
dependency (mcp-go) that is meaningless to readers and will rot.
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