Updated docs by anaslimem · Pull Request #17 · anaslimem/CortexaDB

anaslimem · 2026-03-08T02:09:14Z

Description

I updated the documentation

vercel · 2026-03-08T02:09:18Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
cortexa-db	Ready	Preview, Comment	Mar 8, 2026 2:09am

Copilot

Pull request overview

This PR updates documentation across the CortexaDB project to reflect the v0.1.8 release. The primary changes involve renaming the Python API methods (remember → add, ask → query().execute(), get_memory → get, delete_memory → delete, namespace → collection) and updating version references from v0.1.7 to v0.1.8. It also adds new benchmark data for the batch ingestion feature and introduces a new Observability/Telemetry section to the Rust API docs.

Changes:

Renamed all Python API method references across documentation files (remember→add, ask→query, namespace→collection, etc.) and replaced namespaces.mdx with collections.mdx
Updated version references from v0.1.7 to v0.1.8 throughout README, examples, and docs, including new batch ingestion benchmark data
Updated Rust API docs to use CortexaDBBuilder pattern and added an Observability/Telemetry section

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
`README.md`	Updated version to v0.1.8 and benchmark table
`examples/python/basic_usage.py`	Updated version string and comment to v0.1.8
`docs/content/docs/index.mdx`	Updated API examples to new naming, namespace→collection link
`docs/content/docs/api/python.mdx`	Comprehensive API rename: remember→add, ask→query, namespace→collection, removed legacy `ingest_document`
`docs/content/docs/api/rust.mdx`	Updated to CortexaDBBuilder pattern, added Observability section
`docs/content/docs/getting-started/quickstart.mdx`	Updated Python and Rust quickstart examples to new APIs
`docs/content/docs/guides/collections.mdx`	New file replacing `namespaces.mdx` with updated API naming
`docs/content/docs/guides/namespaces.mdx`	Deleted (replaced by collections.mdx)
`docs/content/docs/guides/meta.json`	Updated sidebar entry from namespaces to collections
`docs/content/docs/guides/replay.mdx`	Updated code examples to new API (add, vector, delete)
`docs/content/docs/resources/benchmarks.mdx`	Added v0.1.8 batch ingestion benchmark table
`docs/content/docs/resources/examples.mdx`	Updated all Python examples to new API naming

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-08T02:17:24Z

docs/content/docs/api/python.mdx

 | `overlap` | `int` | `50` | Overlap between chunks |
 | `metadata` | `dict?` | `None` | Metadata for all chunks |
-| `namespace` | `str?` | `None` | Target namespace |
+| `collection` | `str?` | `None` | Target collection |


The parameter in the table was updated from namespace to collection, but the method signature on line 236 still reads .load(file_path, strategy="markdown", chunk_size=512, overlap=50, metadata=None, namespace=None). The namespace=None in the signature should also be updated to collection=None for consistency.

Copilot · 2026-03-08T02:17:25Z

docs/content/docs/api/python.mdx

 ### `Memory`

-Full memory entry from `.get_memory()`.
+Full memory entry from `.get()`.


The Memory type description here was updated to reference .get(), which is correct. However, the Hit type description a few lines above (line 368) still reads Query result from .ask(). and should be updated to reference .query().execute() instead, to match the new API.

Copilot · 2026-03-08T02:17:25Z

docs/content/docs/api/python.mdx

+mem = db.get(42)
 print(mem.id)          # 42
 print(mem.content)     # b"User prefers dark mode"
 print(mem.namespace)   # "default"


The method was correctly renamed from get_memory to get. However, the example on line 142 still shows print(mem.namespace) # "default" — given that the PR is renaming "namespace" to "collection" throughout, you may want to add a comment clarifying that namespace is the internal field name (which is noted in the Memory type table at line 382), or rename the field for consistency.

Suggested change

print(mem.namespace) # "default"

print(mem.collection) # "default"

Copilot · 2026-03-08T02:17:25Z

docs/content/docs/api/rust.mdx


 ```rust
-use cortexadb_core::CortexaDB;
+use cortexadb_core::{CortexaDB, CortexaDBBuilder};


CortexaDBBuilder is not re-exported from the crate root (cortexadb_core). Looking at crates/cortexadb-core/src/lib.rs:12, only CortexaDB, CortexaDBConfig, CortexaDBError, Memory, and Stats are re-exported from facade. This import would fail to compile. Either update lib.rs to also re-export CortexaDBBuilder, or change the import here to use cortexadb_core::facade::CortexaDBBuilder;.

Suggested change

use cortexadb_core::{CortexaDB, CortexaDBBuilder};

use cortexadb_core::{CortexaDB, facade::CortexaDBBuilder};

Copilot · 2026-03-08T02:17:25Z

docs/content/docs/getting-started/quickstart.mdx


 ```rust
-use cortexadb_core::CortexaDB;
+use cortexadb_core::{CortexaDB, CortexaDBBuilder};


CortexaDBBuilder is not re-exported from the crate root (cortexadb_core). Looking at crates/cortexadb-core/src/lib.rs:12, only CortexaDB, CortexaDBConfig, CortexaDBError, Memory, and Stats are re-exported. This import would fail to compile. Either update lib.rs to also re-export CortexaDBBuilder, or change the import to use cortexadb_core::facade::CortexaDBBuilder;.

Suggested change

use cortexadb_core::{CortexaDB, CortexaDBBuilder};

use cortexadb_core::CortexaDB;

use cortexadb_core::facade::CortexaDBBuilder;

Copilot · 2026-03-08T02:17:26Z

docs/content/docs/guides/meta.json

    "indexing",
    "chunking",
-    "namespaces",
+    "collections",


The renaming from namespaces to collections here and the deletion of namespaces.mdx will break the link [Namespaces](/docs/guides/namespaces) found in docs/content/docs/guides/query-engine.mdx:211. That file also still uses old API names (db.ask(), db.namespace()) throughout. Additionally, several other docs files not included in this PR still reference the old API (remember, ask, namespace) — notably embedders.mdx, core-concepts.mdx, chunking.mdx, query-engine.mdx, and the Rust examples section of examples.mdx. These should be updated in this PR or a follow-up to maintain consistency.

Copilot · 2026-03-08T02:17:26Z

docs/content/docs/resources/benchmarks.mdx


+## Batch Ingestion Performance (v0.1.8)
+
+CortexaDB `v0.1.8` introduced a new batching architecture. Measured on an M1 Pro Mac with 1,000 chunks of text:


The benchmark machine is described as "M1 Pro Mac" here, but the README.md (line 77) says "M2 Mac". These should be consistent — please use the same machine description in both places.

Suggested change

CortexaDB `v0.1.8` introduced a new batching architecture. Measured on an M1 Pro Mac with 1,000 chunks of text:

CortexaDB `v0.1.8` introduced a new batching architecture. Measured on an M2 Mac with 1,000 chunks of text:

Copilot · 2026-03-08T02:17:26Z

docs/content/docs/api/python.mdx

 | `overlap` | `int` | `50` | Overlap between chunks |
 | `metadata` | `dict?` | `None` | Metadata to attach to all chunks |
-| `namespace` | `str?` | `None` | Target namespace |
+| `collection` | `str?` | `None` | Target collection |


The parameter in the table was updated from namespace to collection, but the method signature on line 217 still reads .ingest(text, strategy="recursive", chunk_size=512, overlap=50, metadata=None, namespace=None). The namespace=None in the signature should also be updated to collection=None for consistency.

Updated docs

9a69977

Copilot AI review requested due to automatic review settings March 8, 2026 02:09

Copilot started reviewing on behalf of anaslimem March 8, 2026 02:09 View session

anaslimem merged commit 2c590e2 into main Mar 8, 2026
5 checks passed

Copilot AI reviewed Mar 8, 2026

View reviewed changes

anaslimem deleted the update_the_docs branch March 9, 2026 01:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated docs#17

Updated docs#17
anaslimem merged 1 commit intomainfrom
update_the_docs

anaslimem commented Mar 8, 2026

Uh oh!

vercel bot commented Mar 8, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 8, 2026

Uh oh!

Copilot AI Mar 8, 2026

Uh oh!

Copilot AI Mar 8, 2026

Uh oh!

Copilot AI Mar 8, 2026

Uh oh!

Copilot AI Mar 8, 2026

Uh oh!

Copilot AI Mar 8, 2026

Uh oh!

Copilot AI Mar 8, 2026

Uh oh!

Copilot AI Mar 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	print(mem.namespace) # "default"
	print(mem.collection) # "default"

	use cortexadb_core::{CortexaDB, CortexaDBBuilder};
	use cortexadb_core::{CortexaDB, facade::CortexaDBBuilder};

	use cortexadb_core::{CortexaDB, CortexaDBBuilder};
	use cortexadb_core::CortexaDB;
	use cortexadb_core::facade::CortexaDBBuilder;


		## Batch Ingestion Performance (v0.1.8)

		CortexaDB `v0.1.8` introduced a new batching architecture. Measured on an M1 Pro Mac with 1,000 chunks of text:

Conversation

anaslimem commented Mar 8, 2026

Description

Uh oh!

vercel bot commented Mar 8, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 8, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants