Commit 61e57c6
docs: reorganize docs, align homepage copy, and fix build deps (#167)
## 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.
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## 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
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: wangyunlai <hnwyllmm@126.com>1 parent 51f549f commit 61e57c6
File tree
15 files changed
+1340
-1293
lines changed- demo/rag
- docs
- guide
15 files changed
+1340
-1293
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
0 commit comments