xiaoxue_admin
/
zvec
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat(docs): add join us (#54)

This commit is contained in:
Cuiys 2026-02-02 18:49:02 +08:00 committed by GitHub
parent b5f0469ab4
commit 36e84f5e69
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 48 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.github/ISSUE_TEMPLATE/config.yml vendored
View File

@ -1,9 +1,9 @@
blank_issues_enabled: false
contact_links:
- name: Documentation
url: https://github.com/your-org/zvec#readme
about: Check the README, build guide, and API docs first.
url: https://zvec.org/en/
about: Check the quickstart, build guide, and API docs first.
- name: Python API Examples
url: https://github.com/your-org/zvec/tree/main/examples
url: https://zvec.org/en/docs/quickstart/
about: See working usage examples.

12
CONTRIBUTING.md
View File

@ -17,13 +17,21 @@ By participating, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md
- A C++17-compatible compiler (e.g., `g++-11+`, `clang++`, Apple Clang on macOS)
### Clone & Initialize
```bash
git clone --recursive https://github.com/your-org/zvec.git
cd zvec
```
> 💡 **Submodule tip**: If you forgot `--recursive`, run:
> `git submodule update --init --recursive`
> 💡 **Tip**
> - Forgot `--recursive`? Run:
> ```bash
> git submodule update --init --recursive
> ```
> - Set up pre-commit hooks:
> ```bash
> pip install pre-commit && pre-commit install
> ```
### Build from Source (Editable Install)
```bash

36
README.md
View File

@ -20,7 +20,8 @@
<a href="https://zvec.org/en/">🏠 <strong>Home</strong> </a> |
<a href="https://zvec.org/en/docs/">📚 <strong>Docs</strong> </a> |
<a href="https://zvec.org/en/docs/benchmarks/">📊 <strong>Benchmarks</strong> </a> |
<a href="https://discord.gg/rKddFBBu9z">💜 <strong>Discord</strong> </a>
<a href="https://discord.gg/rKddFBBu9z">🎮 <strong>Discord</strong> </a> |
<a href="https://x.com/zvec_ai">🐦 <strong>X (Twitter)</strong> </a>
</p>
**Zvec** is an open-source, in-process vector database — lightweight, lightning-fast, and designed to embed directly into applications. Built on **Proxima** (Alibaba's battle-tested vector search engine), it delivers production-grade, low-latency, scalable similarity search with minimal setup.
@ -88,6 +89,39 @@ Zvec delivers exceptional speed and efficiency, making it ideal for demanding pr
For detailed benchmark methodology, configurations, and complete results, please see our [Benchmarks documentation](https://zvec.org/en/docs/benchmarks/).
## 🤝 Join Our Community
<div align="center">
Stay updated and get support — scan or click:
<table align="center" style="border-collapse: collapse; margin: 16px auto; width: 100%; max-width: 520px;">
<tr>
<td align="center" style="padding: 8px; width: 25%;">
<div style="font-weight: 600; font-size: 14px; margin-bottom: 6px;">💬 DingTalk</div>
<img src="https://zvec.oss-cn-hongkong.aliyuncs.com/qrcode/dingding.png" width="100" style="border-radius: 8px; border: 1px solid #ddd;">
</td>
<td align="center" style="padding: 8px; width: 25%;">
<div style="font-weight: 600; font-size: 14px; margin-bottom: 6px;">📱 WeChat</div>
<img src="https://zvec.oss-cn-hongkong.aliyuncs.com/qrcode/wechat.png" width="100" style="border-radius: 8px; border: 1px solid #ddd;">
</td>
<td align="center" style="padding: 8px; width: 25%;">
<div style="font-weight: 600; font-size: 14px; margin-bottom: 6px;">🎮 Discord</div>
<a href="https://discord.gg/rKddFBBu9z" target="_blank" style="display: inline-block; width: 100px; height: 100px; background: #5865F2; border-radius: 8px; text-decoration: none; color: white; font-size: 12px; display: flex; align-items: center; justify-content: center; line-height: 1;">
Join Server
</a>
</td>
<td align="center" style="padding: 8px; width: 25%;">
<div style="font-weight: 600; font-size: 14px; margin-bottom: 6px;">🐦 X (Twitter)</div>
<a href="https://x.com/zvec_ai" target="_blank" style="display: inline-block; width: 100px; height: 100px; background: #000; border-radius: 8px; text-decoration: none; color: white; font-size: 12px; display: flex; align-items: center; justify-content: center; line-height: 1;">
Follow @zvec_ai
</a>
</td>
</tr>
</table>
</div>
## ❤️ Contributing
We welcome and appreciate contributions from the community! Whether you're fixing a bug, adding a feature, or improving documentation, your help makes Zvec better for everyone.