docs(rust): user-facing README for the Rust ccc build#197
Merged
Conversation
Add a "How it uses the CocoIndex Rust SDK" section to rust/PORTING.md — a code-grounded walkthrough of the SDK API the port exercises (Environment/App/run, ContextKey DI + change detection, #[cocoindex::function] memoization, walk_dir + mount_each!, the sqlite/vec0 table target + declare_row, and the sqlite-vec from_pool gotcha). Snippets cite live file:line anchors so the doc stays verifiable against the source. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
badmonster0
changed the title
Rename rust/PORTING.md -> rust/README.md and rewrite as a Rust-only usage doc: drop the Python->Rust module map, the parity audit, the Python backward-compat section, and the "vs Python" deltas. Keep build/run, architecture, the "How it uses the CocoIndex Rust SDK" walkthrough, CLI commands, configuration, testing, and a plain limitations/follow-ups list. Update the e2e fixture that copies the doc as a sample markdown file. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
badmonster0
force-pushed
the
docs/rust-sdk-usage
branch
from
6193d8e to
1af60f8
Compare
…fig) Drop the SDK-internals walkthrough. The Rust README now mirrors the main cocoindex-code README's user-facing structure — Install (build from source), Quick start, Coding Agent Integration (Skill + MCP), CLI Reference, Search options, MCP tool reference, Configuration (user/project settings), Supported languages, and a short "Differences from the Python build" note (local-only embeddings; no custom Python chunkers). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
badmonster0
changed the title
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
1 participant
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.
Replaces
rust/PORTING.mdwith a user-facingrust/README.mdfor the native Rustcccbuild — structured to match the main cocoindex-code README.Sections: Features · Install (build from source) · Quick start · Coding Agent Integration (Skill + MCP) · CLI Reference · Search options · MCP tool reference · Configuration (user + project settings) · Supported languages · Differences from the Python build.
Scope notes captured honestly: embeddings are local-only (fastembed, default
BAAI/bge-small-en-v1.5; no LiteLLM/cloud); custom Python chunkers aren't supported (config still parses); index DBs are interchangeable with the Python build.No Python-port framing, no SDK-internals walkthrough — purely how a user installs and uses the tool.
Also updates the
e2e_advanced.shfixture that copies the doc as a sample markdown file.