chore(release): 3.0.0b2 + follow-up doc cleanups#25
Merged
Conversation
…grammar The recommended download path (`idc` CLI) was named on every agent-facing surface but only the human user guide said it comes from `pip install idc-index` — an agent relaying the commands couldn't tell the user how to get the tool. Add the install hint to DownloadInfo.note and the idc://guide retrieval step. Also fix 'append '/*' is a' -> 'as a' in the get_cohort_urls response note. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Set the package version to 3.0.0b2 and fold the unreleased changelog entries (local-download removal, source=gcs manifest fix) under it, dated today. uv.lock's idc-api pin is synced in the same commit. The version is baked into the image when test builds it, so this must be promoted to test before tagging v3.0.0b2. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The dev/ docs still described the pre-removal model (stdio downloads, hosted doesn't): run-command comments, the 501 mapping in the test table, a phantom download service in the project layout, and the deployment notes/tool count. Retrieval is manifests/URLs only on every transport since the surface was removed. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Prepares the 3.0.0b2 beta release of idc-api and performs follow-up documentation cleanups after the prior removal of the local-download surface, ensuring the docs and user-facing guidance consistently reflect “manifests/URLs only” retrieval.
Changes:
- Bump package/version metadata to 3.0.0b2 (project + lockfile) and add the dated 3.0.0b2 changelog section with updated compare links.
- Clarify retrieval guidance in MCP/user-facing text, including where the
idcCLI comes from (pip install idc-index) and a small s5cmd wildcard grammar fix. - Remove stale “local-download” references from developer/deployment documentation and update the hosted MCP tool count.
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| uv.lock | Updates the locked editable package version to 3.0.0b2. |
| pyproject.toml | Bumps idc-api project version to 3.0.0b2. |
| CHANGELOG.md | Adds the 3.0.0b2 section and updates link references for the new release. |
| src/idc_api/mcp/server.py | Improves retrieval instructions (CLI install hint; s5cmd wildcard note grammar). |
| src/idc_api/core/services/manifest.py | Updates API-facing download guidance to include CLI install hint. |
| dev/developer_guide.md | Removes obsolete local-download wording and updates project layout/test descriptions. |
| dev/deployment.md | Aligns hosted MCP deployment notes with “server never transfers files” and updates tool count. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Release prep for 3.0.0b2, following up on #24 (which merged the local-download removal itself). Three commits:
pyproject.toml/uv.lockand the dated CHANGELOG section (the download-surface removal recorded as a beta contract change, plus thesource=gcsmanifest fix).idcCLI comes from (pip install idc-index); fix the s5cmd wildcard note grammar.dev/developer_guide.md,dev/deployment.md): run-command comments, the gone 501 mapping, a phantomdownloadservice in the project layout, the hosted-vs-stdio download notes, and thetools/listcount (19 → 18).A repo sweep for b2 readiness found nothing else: tests (74) pass, ruff lint/format clean, version single-sourced, no dead code from the removal, and
docs/user-guide.md/idc://guide/INSTRUCTIONS/ README are already consistent.🤖 Generated with Claude Code