Repository navigation
docs: make setup instructions clear before and after the release - #132
Conversation
PatrickSys
changed the title
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: fb5911d045
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| ### New in 2.4.0 | ||
|
|
||
| Replace `[feature]` with something you want to find. The agent supplies the repository path in its tool calls, so the registration can serve different projects. Initial indexing may need a local model download. The October 6 isolated checks proved these client registrations and published-package project selection/search; they did not establish a full native agent investigation. | ||
| - Opt-in NestJS support from community contributor Aaron Olin. See the [analyzer options](./docs/capabilities.md#analyzers). |
There was a problem hiding this comment.
For NestJS projects, the server registers NestJsAnalyzer unconditionally in src/index.ts:66, and AnalyzerRegistry.findAnalyzer selects registered analyzers solely through canAnalyze (src/core/analyzer-registry.ts:88-90); the documented analyzers.nestjs.enabled value is never consulted. Readers are therefore told that support is opt-in and linked to a switch that has no effect, while MCP/CLI analysis actually activates automatically when NestJS code matches. Either wire the flag into analyzer selection or document the analyzer as automatic.
AGENTS.md reference: AGENTS.md:L112-L112
Useful? React with 👍 / 👎.
| # Capabilities Reference | ||
|
|
||
| Technical reference for what `codebase-context` ships today. The public product posture is map first, find second: the bounded conventions map is the first-call surface, and search narrows to the right local example after that. For the user-facing overview, see [README.md](../README.md). | ||
| Technical reference for the 2.4.0 setup preview. The public product posture is map first, find second: the bounded conventions map is the first-call surface, and search narrows to the right local example after that. For the user-facing overview, see [README.md](../README.md). |
There was a problem hiding this comment.
Once 2.4.0 is published, this introduction will still describe the current release as a “setup preview,” as will the new wording on lines 32 and 55. That recreates the exact stale post-publication state this change is intended to avoid; the added test misses it because it only rejects the exact bold phrase **2.4.0 setup preview:**. Use wording that remains accurate both before and after publication.
Useful? React with 👍 / 👎.
 [Medium impact] The PR reaches setup instructions for package users and the npm release workflow. Correct the NestJS claims before merging to meet the repository’s requirement for evidence-backed public docs. Findings
SummaryThe PR prepares setup instructions for 2.4.0 while linking to the published 2.2.0 guide.
Reviews (1) · Last reviewed commit: "Fix 2.4.0 setup notices" · Reviewed by Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| Replace `[feature]` with something you want to find. The agent supplies the repository path in its tool calls, so the registration can serve different projects. Initial indexing may need a local model download. The October 6 isolated checks proved these client registrations and published-package project selection/search; they did not establish a full native agent investigation. | ||
| - Opt-in NestJS support from community contributor Aaron Olin. See the [analyzer options](./docs/capabilities.md#analyzers). | ||
| - Better React/Next.js detection and a fix for reranker passage scoring. | ||
| - Transformers.js v4 for local models. |
There was a problem hiding this comment.
The server and library register NestJsAnalyzer by default, and analyzer selection never checks config.analyzers.nestjs.enabled. The new opt-in wording and the switch documented in the matching guide therefore describe behavior the code does not provide.
Remove those claims or implement and test the switch. The repository requires evidence-backed public docs and forbids claims about capabilities that are not shipped and tested. That requirement must be satisfied before merging.
Context Used: AGENTS.md (source)
Knowledge Base Used: Framework analyzer registry
| # Capabilities Reference | ||
|
|
||
| Technical reference for what `codebase-context` ships today. The public product posture is map first, find second: the bounded conventions map is the first-call surface, and search narrows to the right local example after that. For the user-facing overview, see [README.md](../README.md). | ||
| Technical reference for the 2.4.0 setup preview. The public product posture is map first, find second: the bounded conventions map is the first-call surface, and search narrows to the right local example after that. For the user-facing overview, see [README.md](../README.md). |
There was a problem hiding this comment.
This page still calls 2.4.0 a setup preview in its introduction, setup links, and limitations section. Those descriptions remain after publication, leaving the before-and-after-release fix incomplete. Use release-neutral wording throughout the page and extend the wording test beyond the single exact preview label it currently rejects.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
|
|
||
| ```bash | ||
| claude mcp add --scope user --transport stdio codebase-context -- npx -y codebase-context@2.2.0 | ||
| claude mcp add --scope user --transport stdio codebase-context -- npx -y codebase-context@2.4.0 |
There was a problem hiding this comment.
The client recipes now run 2.4.0, but their nearby “Connected locally” and “What was checked” notes describe checks made with 2.2.0. Only the later Desktop and routing sections explain that boundary. Label the client checks as historical 2.2.0 evidence too, so readers do not mistake them for checks of the new commands.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
| Use Node.js 22 or newer for these recipes. The package declares Node 18+, but native dependency requirements are narrower than that broad declaration; these checks do not establish Node 18.0 compatibility. | ||
| Codebase Context runs as a local MCP server: a tool your AI editor or command-line client can call while it works. Register it without a fixed folder, then let the agent supply its current repository through the `project` tool parameter. These recipes target the 2.4.0 release. | ||
|
|
||
| Use Node.js 22 or newer for these recipes. The package still declares Node 18+, but the built pack failed to index source on Node 18.20.4 with `ReferenceError: crypto is not defined` in UUID chunk creation. Node 22 is the lowest version used successfully in the package check; the engine declaration remains an open compatibility issue. |
There was a problem hiding this comment.
The rewritten note says the package still declares Node 18+ and that its engine declaration remains an open issue. The current package.json already requires Node 22 or newer. Update this paragraph to match that requirement and label the Node 18 failure as historical if it is worth keeping.
1 participant
The setup warning would still call 2.4.0 a preview after it was published.
The README and matching guides now explain which version the commands use and where to find the published 2.2.0 guide.
The existing README layout stays the same.
Tested: the new wording test failed before the change; all six release tests pass, plus build and type checks.