ofx-labs/seekdb-docs
Overview
This skill provides fast, comprehensive access to SeekDB vector database documentation covering both core developer topics and the Python SDK user guide. It helps developers and users find environment setup instructions, coding standards, testing/debugging guides, and full Python API references. Use it to locate specific docs, examples, and API details in English or Chinese sources.
How this skill works
The skill inspects the organized documentation tree and directs queries to the appropriate section: developer guide for C++ core work and user guide for Python SDK usage. It locates files such as environment setup, coding conventions, testing guides, and the complete Python SDK API reference including client modes, collection and data operations, queries, filters, and embedding functions. For targeted searches it uses the document index to jump to exact markdown files and supports searching across files when needed.
When to use it
- Setting up the SeekDB development toolchain, build, or IDE settings
- Following coding standards or contributing to the SeekDB core
- Writing, testing, or debugging SeekDB core components in C++
- Using the Python SDK: clients, collections, data operations, or queries
- Implementing embeddings, AdminClient workflows, or hybrid search
- Quickly locating a specific doc page or API reference in English or Chinese
Best practices
- Start by identifying whether your question is developer-focused or SDK/API-focused to pick the correct guide
- Reference the doc-index first to find exact filenames and paths (developer-guide/ or user-guide/)
- Use the Python SDK reference for concrete method signatures and examples before writing client code
- Follow coding-convention and coding-standard docs when contributing changes to core code
- Run unit and mysqltest guides for reproducible testing; consult debug.md for troubleshooting steps
Example use cases
- A new contributor needs a step-by-step environment setup and build instructions for core development
- An engineer wants method names and arguments for Python SDK collection.create, upsert, or hybrid_search
- A QA engineer follows unittest.md and mysqltest.md to reproduce and log a failing test
- A maintainer verifies logging, memory, or container guidelines when diagnosing production issues
- A developer looks up coding standards before submitting a pull request
FAQ
Yes, all documentation is available in both English (en/) and Chinese (zh/).
Where is the complete listing of all documentation files?
Consult the document index (references/doc-index.md) to see the full file list and paths.
