Skip to content

docs: update README with embeddings and vector stores#43

Merged
ancongui merged 2 commits into
mainfrom
develop
Feb 24, 2026
Merged

docs: update README with embeddings and vector stores#43
ancongui merged 2 commits into
mainfrom
develop

Conversation

@ancongui
Copy link
Copy Markdown
Contributor

Summary

  • Update test count badge (1074 → 1383)
  • Add Embeddings & Vector Stores to architecture diagram and protocol hierarchy
  • Add feature highlights for embeddings (8 providers) and vector stores (4 backends)
  • Add RAG quick start example (step 8)
  • Add all embedding/vectorstore extras to optional dependencies table
  • Add module reference links for embeddings and vector stores docs
  • Update protocol count (11 → 13) and dev test count

Test plan

  • 1383 tests passing, no regressions
  • README-only change, no code modifications

- Update test count badge (1074 → 1383)
- Add Embeddings & Vector Stores to architecture diagram
- Add EmbeddingProtocol and VectorStoreProtocol to protocol hierarchy
- Add feature highlights for embeddings (8 providers) and vector stores (4 backends)
- Add RAG quick start example (step 8)
- Add embedding/vectorstore extras to optional deps table
- Add embeddings and vector stores to module reference links
- Update protocol count (11 → 13) and test count in dev section
@ancongui ancongui enabled auto-merge (squash) February 24, 2026 14:59
GitHub mermaid renderer cannot parse & in subgraph labels.
@ancongui ancongui merged commit 6cb1f0b into main Feb 24, 2026
10 checks passed
ancongui added a commit that referenced this pull request May 31, 2026
* docs: update README with embeddings and vector stores

- Update test count badge (1074 → 1383)
- Add Embeddings & Vector Stores to architecture diagram
- Add EmbeddingProtocol and VectorStoreProtocol to protocol hierarchy
- Add feature highlights for embeddings (8 providers) and vector stores (4 backends)
- Add RAG quick start example (step 8)
- Add embedding/vectorstore extras to optional deps table
- Add embeddings and vector stores to module reference links
- Update protocol count (11 → 13) and test count in dev section

* fix: use slash instead of ampersand in mermaid subgraph name

GitHub mermaid renderer cannot parse & in subgraph labels.
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