From 36e84f5e69e81fbd4c423e2e2083de2419da16af Mon Sep 17 00:00:00 2001 From: Cuiys Date: Mon, 2 Feb 2026 18:49:02 +0800 Subject: [PATCH] feat(docs): add join us (#54) --- .github/ISSUE_TEMPLATE/config.yml | 6 +++--- CONTRIBUTING.md | 12 +++++++++-- README.md | 36 ++++++++++++++++++++++++++++++- 3 files changed, 48 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 98d35ad..6a2d7c5 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c4d7b8f..3c0d1c8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/README.md b/README.md index b81b097..3a1f3b9 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,8 @@ 🏠 Home | 📚 Docs | 📊 Benchmarks | - 💜 Discord + 🎮 Discord | + 🐦 X (Twitter)

**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 + +
+ +Stay updated and get support — scan or click: + + + + + + + + +
+
💬 DingTalk
+ + 		+
📱 WeChat
+ + 		+
🎮 Discord
+ + Join Server + + 		+
🐦 X (Twitter)
+ + Follow @zvec_ai + +
+ +
+ ## ❤️ 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.