Skip to content

docs(examples): retire legacy integration examples#1124

Merged
zhoujh01 merged 1 commit intomainfrom
docs/retire-legacy-examples
Mar 31, 2026
Merged

docs(examples): retire legacy integration examples#1124
zhoujh01 merged 1 commit intomainfrom
docs/retire-legacy-examples

Conversation

@qin-ctx
Copy link
Copy Markdown
Collaborator

@qin-ctx qin-ctx commented Mar 31, 2026

Description

Retire legacy example integrations that no longer match the current OpenViking server and MCP design, and refresh the basic usage example so it points at the supported configuration, server, and MCP flows.

Related Issue

N/A

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (no functional changes)
  • Performance improvement
  • Test update

Changes Made

  • Remove the deprecated examples/mcp-query, examples/server_client, and examples/misc example paths.
  • Rewrite examples/basic-usage documentation to reflect the current SDK, server-mode, and MCP guidance.
  • Update examples/basic-usage/basic_usage.py so the example flow matches current client behavior more reliably.

Testing

  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have tested this on the following platforms:
    • Linux
    • macOS
    • Windows

Manual validation:

  • Ran python -m py_compile examples/basic-usage/basic_usage.py
  • Verified stale example references were removed from active example docs

Checklist

  • My code follows the project's coding style
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

Screenshots (if applicable)

N/A

Additional Notes

  • examples/opencode/plugin was intentionally kept in place.
  • An unrelated unstaged local deletion of examples/claude-memory-plugin/README_CN.md was left out of this PR.

Remove outdated mcp-query, server_client, and misc example paths, and refresh
basic-usage docs and script to point at the current server and MCP flows.
@github-actions
Copy link
Copy Markdown

Failed to generate code suggestions for PR

@zhoujh01 zhoujh01 merged commit 4587f87 into main Mar 31, 2026
16 checks passed
@zhoujh01 zhoujh01 deleted the docs/retire-legacy-examples branch March 31, 2026 09:52
@github-project-automation github-project-automation bot moved this from Backlog to Done in OpenViking project Mar 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants