Skip to content

docs(skill): sync ov add-memory output example after #1613#1627

Merged
qin-ctx merged 1 commit intovolcengine:mainfrom
r266-tech:docs-skill-add-memory-output-drift-1613
Apr 22, 2026
Merged

docs(skill): sync ov add-memory output example after #1613#1627
qin-ctx merged 1 commit intovolcengine:mainfrom
r266-tech:docs-skill-add-memory-output-drift-1613

Conversation

@r266-tech
Copy link
Copy Markdown
Contributor

Description

ov add-memory CLI output documented in examples/skills/ov-add-data/SKILL.md no longer matches actual behavior after #1613 (merged 2026-04-21 by @qin-ctx).

crates/ov_cli/src/commands/session.rs was changed to emit a simple "OK" because the commit endpoint runs asynchronously and memories_extracted isn't meaningful at response time:

// before
let memories_extracted = commit_response["memories_extracted"].as_i64().unwrap_or(0);
let result = json!({ "memories_extracted": memories_extracted });
output_success(&result, output_format, compact);

// after (#1613)
output_success(&json!("OK"), output_format, compact);

But SKILL.md still shows the old expected output:

memories_extracted   1

An agent reading this skill to decide whether add-memory succeeded will be confused when the CLI just prints OK.

Fix

Update the "Output" section in examples/skills/ov-add-data/SKILL.md to reflect the new OK output and note that extraction runs async after commit is queued.

Type of Change

  • Documentation update

Test plan

  • Visually diffed against #1613's session.rs change (output_success(&json!("OK"), ...))
  • Confirmed no other add-memory output example in the repo needs updating (memories_extracted still appears in docs/{en,zh}/api/05-sessions.md and docs/{en,zh}/concepts/08-session.md but those document the /commit HTTP API response body, which still carries memories_extracted — not the CLI)

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

PR volcengine#1613 changed 'ov add-memory' to print 'OK' instead of
memories_extracted count because commit runs async.
The SKILL.md example still showed the old count output.
@github-actions
Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅

1613 - Fully compliant

Compliant requirements:

  • Updated examples/skills/ov-add-data/SKILL.md to reflect new ov add-memory output
  • Changed output example from memories_extracted 1 to OK
  • Added note that memory extraction runs asynchronously
⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🏅 Score: 100
🧪 No relevant tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ No major issues detected

@github-actions
Copy link
Copy Markdown

PR Code Suggestions ✨

No code suggestions found for the PR.

@qin-ctx qin-ctx merged commit 0b6f2d5 into volcengine:main Apr 22, 2026
1 check passed
@github-project-automation github-project-automation Bot moved this from Backlog to Done in OpenViking project Apr 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants