docs: reorganize docs, align homepage copy, and fix build deps

[PsiACE]

Summary

Reorganize the documentation into a Markdown-based structure, update the docs homepage content, and keep the README aligned with the new documentation entry points.

Solution Description

Split the legacy README content into guide pages, move installation into the docs homepage, remove deprecated sections (RAG demo and license) from the guide, add contributing info, and normalize guide heading levels. Added sphinx-multiversion to dev dependencies to ensure docs build cleanly.

Summary by CodeRabbit

• Documentation
  • Added comprehensive user guides covering client connection, collection management, data operations, and embedding functions
  • Added AdminClient documentation with database management examples
  • Added RAG demo guide with three embedding modes (default, local, API)
  • Reorganized README to highlight documentation link and quick-start examples
  • Added contributor development and testing guide

[coderabbitai]

Warning

Rate limit exceeded

@hnwyllmm has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 26 minutes and 15 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📝 Walkthrough

Walkthrough

This PR restructures the project documentation, migrating from RST to Markdown, creates comprehensive user guides covering client connection, admin client, collection management, DML/DQL operations, and embedding functions, adds a CONTRIBUTING.md with development workflows, updates demo READMEs with RAG setup instructions, and condenses the main README to reference external documentation.

Changes

Cohort / File(s)	Summary
Documentation Restructuring docs/index.rst, docs/index.md, docs/guide/index.md	Migrates main documentation from RST to Markdown format; establishes guide index and new main documentation entry point.
User Guide Documentation docs/guide/client-connection.md, docs/guide/admin-client.md, docs/guide/collection-management.md, docs/guide/dml.md, docs/guide/dql.md, docs/guide/embedding-functions.md	Introduces six comprehensive guide files documenting client interfaces, admin operations, collection management, DML/DQL operations, and custom embedding function implementation.
Demo Documentation demo/rag/README.md, demo/rag/README_CN.md	Adds RAG demo setup and usage documentation in English and Chinese, detailing embedding modes, prerequisites, and workflow instructions.
Project Root Documentation README.md, CONTRIBUTING.md	Condenses README to focus on quick start and links to external guide; introduces new CONTRIBUTING.md covering development environment setup, Make targets, and testing workflows.
Development Dependencies pyproject.toml	Adds sphinx-multiversion to dev dependencies to support multi-version documentation builds.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• Add explicit UV CLI workflow for pyseekdb #154 — Overlaps with README.md documentation modifications and UV CLI development/testing workflow guidance.
• chore: migrate to uv and simplify build workflow #107 — Shares changes to demo/rag README and workspace setup instructions as part of uv migration.
• document website by github pages #89 — Related through modifications to Sphinx documentation structure and docs/index files.

Poem

🐰 A documentation warren, so neat and refined,
Guides, READMEs, and CONTRIBUTINGs, all redesigned,
From RST to Markdown, we hoppy-hop along,
With embedding functions and DQL songs,
Demo RAGs in two tongues—our warren grows strong! 🌟

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title accurately summarizes the main changes: reorganizing documentation structure, updating homepage copy, and adding a missing build dependency (sphinx-multiversion).
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 5

🤖 Fix all issues with AI agents

In `@docs/guide/admin-client.md`:
- Around line 47-49: The document header for "## 2.4 Database Object" is
misnumbered (skips 2.3); update the section number to "## 2.3 Database Object"
(or insert the missing 2.3 section if intended) and ensure any cross-references
or TOC entries that mention this header or the `get_database()` and
`list_databases()` methods are updated accordingly so numbering and navigation
remain consistent.

In `@docs/guide/client-connection.md`:
- Around line 58-67: The call to pyseekdb.Client has a syntax error: the keyword
argument user="root" is missing a trailing comma which breaks the argument list;
update the pyseekdb.Client invocation in the docs to add a comma after
user="root" so the parameters (host, port, database, user, optional password)
are correctly separated.

In `@docs/guide/collection-management.md`:
- Around line 25-31: The example uses an undefined symbol
UserDefinedEmbeddingFunction which will raise a NameError; update the snippet so
the embedding function is importable or clearly marked as a placeholder: either
replace UserDefinedEmbeddingFunction with a real importable class (and mention
the import) or add a short inline comment above the instantiation (near
UserDefinedEmbeddingFunction and the embedding_function argument passed to
client.create_collection) stating it is a user-provided/placeholder
implementation so readers know to supply their own implementation.

In `@docs/guide/embedding-functions.md`:
- Line 7: The documentation line for DefaultEmbeddingFunction has a stray quote
in the model name; update the text referencing DefaultEmbeddingFunction so the
model name reads correctly as all-MiniLM-L6-v2 (remove the extra single quote)
wherever it appears in embedding-functions.md and any other docs referencing
DefaultEmbeddingFunction's default model.
- Around line 127-210: Update the OpenAIEmbeddingFunction example to use the new
OpenAI SDK and recommended embedding model: change the default model_name to a
current model like "text-embedding-3-small" and set _dimension to 512 (or to
3072 if using "text-embedding-3-large"), and replace the deprecated
openai.Embedding.create call inside __call__ with an initialized OpenAI client
(e.g., client = openai.OpenAI(api_key=...)) and
client.embeddings.create(model=self.model_name, input=input). Also adjust the
constructor/api_key handling and the dimension property logic to reflect the new
model defaults (check model_name to set _dimension when constructing
OpenAIEmbeddingFunction).

🧹 Nitpick comments (1)

pyproject.toml (1)

34-34: Consider replacing sphinx-multiversion with the maintained fork sphinx-multiversion-contrib.

While sphinx-multiversion==0.2.4 is a valid version with no known security vulnerabilities, the package hasn't been maintained since August 2020. Using a 5+ year old Sphinx extension with Sphinx 8.2.3 may encounter untested compatibility issues. The actively maintained fork sphinx-multiversion-contrib is available as a drop-in replacement with newer fixes and features.