docs: Add basic usage example and Chinese documentation for examples#979
Merged
MaojiaSheng merged 2 commits intovolcengine:mainfrom Mar 26, 2026
Merged
docs: Add basic usage example and Chinese documentation for examples#979MaojiaSheng merged 2 commits intovolcengine:mainfrom
MaojiaSheng merged 2 commits intovolcengine:mainfrom
Conversation
- Add README_CN.md for claude-memory-plugin - Add README_CN.md for k8s-helm - Add README_CN.md for mcp-query These translations help Chinese users understand the example usage and configuration.
|
|
- Add comprehensive README.md with code examples - Add Chinese version README_CN.md - Add basic_usage.py demonstrating core features: - Initialization (embedded mode and HTTP client mode) - Adding resources (URLs, files, directories) - Browsing the virtual filesystem - Semantic search and retrieval - Tiered context loading (L0/L1/L2) - Session management for memory This example helps developers quickly get started with OpenViking.
xingzihai
changed the title
MaojiaSheng
approved these changes
Mar 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds:
Changes
New: Basic Usage Example (
examples/basic-usage/)Chinese Translations Added
examples/claude-memory-plugin/README_CN.md- Claude Code memory plugin documentationexamples/k8s-helm/README_CN.md- Kubernetes Helm Chart deployment guideexamples/mcp-query/README_CN.md- MCP Server usage documentationMotivation
The existing examples focus on integration with specific tools. This PR adds a beginner-friendly example demonstrating core Python SDK functionality.
Testing
感谢审核此贡献！