Skip to content

docs(claude-code): describe session-start profile injection (#1914)#1962

Merged
ZaynJarvis merged 2 commits into
volcengine:mainfrom
r266-tech:docs-claude-code-session-start-profile-injection-1914
May 11, 2026
Merged

docs(claude-code): describe session-start profile injection (#1914)#1962
ZaynJarvis merged 2 commits into
volcengine:mainfrom
r266-tech:docs-claude-code-session-start-profile-injection-1914

Conversation

@r266-tech
Copy link
Copy Markdown
Contributor

Summary

docs/{en,zh}/agent-integrations/02-claude-code.md Hook behavior table still
describes the pre-#1914 SessionStart row — only the
archive-overview-on-resume/compact half. After #1914 (feat(claude-code-plugin): session-start profile injection, /ov status command, tool-output capture cleanup,
@t0saki author / merged 2026-05-08 by @ZaynJarvis) every session source
(startup/clear/resume/compact) also injects profile.md + an annotated ls of
preferences/ + entities/, capped by OPENVIKING_PROFILE_TOKEN_BUDGET
(default 10000 tokens, CJK-aware; OPENVIKING_NO_AUTO_INJECT=1 skips). Both
halves now compose into a single <openviking-context> envelope.

This PR rewrites the SessionStart cell in both EN + ZH tables to reflect both
halves of the new behavior, verbatim-aligned to the source-of-truth JSDoc in
examples/claude-code-memory-plugin/scripts/session-start.mjs.

Scope is intentionally narrow — single row per file (2 net LOC). The new
/ov slash command and the TOOL_BLOCK_MAX_CHARS → TOOL_RESULT_MAX_CHARS
rename from the same PR are not (yet) surfaced in the agent-integration doc;
deferred to follow-up so this PR stays a focused docs-drift catch.

What changed

  • docs/en/agent-integrations/02-claude-code.md — 1 row updated under "Hook
    behavior" (line ~165).
  • docs/zh/agent-integrations/02-claude-code.md — same row in the ZH mirror.

Verification

  • Source-of-truth: examples/claude-code-memory-plugin/scripts/session-start.mjs
    JSDoc lines 4-19 describe the two-injection compose semantics, env var names,
    and defaults used in the doc row.
  • OPENVIKING_PROFILE_TOKEN_BUDGET / OPENVIKING_NO_AUTO_INJECT resolve from
    scripts/config.mjs and are only currently grep-able in the source tree, not
    in any doc page → user-facing default+opt-out surface added.

Notes

  • Maintainer can pin/skip if /ov and the env vars are still under polish and
    the agent-integration page should lag the plugin README — happy to split or
    drop. Code reviewer perspective on row length / wording welcome.

@github-actions
Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis 🔶

1914 - Partially compliant

Compliant requirements:

  • Update documentation for session-start profile injection

Non-compliant requirements:

  • (No other ticket requirements are in scope for this docs-only PR)
⏱️ 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.

@ZaynJarvis ZaynJarvis merged commit b88b9c3 into volcengine:main May 11, 2026
3 checks passed
@github-project-automation github-project-automation Bot moved this from Backlog to Done in OpenViking project May 11, 2026
ZaynJarvis pushed a commit that referenced this pull request May 13, 2026
…1962)

* docs(claude-code): describe session-start profile injection from #1914

* docs(claude-code): describe session-start profile injection from #1914 (zh)
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