Skip to content

docs(storage): document task_tracker backend config from #1949#1971

Merged
qin-ctx merged 2 commits into
volcengine:mainfrom
r266-tech:docs-storage-task-tracker-1949
May 11, 2026
Merged

docs(storage): document task_tracker backend config from #1949#1971
qin-ctx merged 2 commits into
volcengine:mainfrom
r266-tech:docs-storage-task-tracker-1949

Conversation

@r266-tech
Copy link
Copy Markdown
Contributor

Summary

Document the new storage.task_tracker.backend configuration field added in #1949 (zhoujh01 / MaojiaSheng, 2026-05-11T03:06:31Z, feat: Persist task tracker). Both docs/en/guides/01-configuration.md and docs/zh/guides/01-configuration.md currently have zero mention of task_tracker, so operators reading the configuration guide cannot discover the field or know to enable persistent for multi-instance deployments.

What's documented

  • New ## storage.task_tracker Section (EN) / ## storage.task_tracker 段 (ZH) inserted adjacent to storage.transaction in each file
  • JSON example with default backend: "memory" (preserves existing single-process behavior)
  • Parameter table mirroring TaskTrackerConfig.backend (Literal["memory","persistent"], default "memory") verbatim from openviking_cli/utils/config/storage_config.py
  • Brief operator guidance: when to flip to persistent (cross-instance task_id lookup or restart survival)

Description copy uses task_type naming (session_commit / add_resource / add_skill / admin_reindex) matching #1949 PR body. Limitations called out in the PR's "非目标" list (no auto-cleanup, no lease/heartbeat, no takeover, no CAS — last-write-wins) are deliberately NOT advertised as features.

Verification

# field & default verified against source
grep -nA3 'class TaskTrackerConfig' openviking_cli/utils/config/storage_config.py

# pre-flight sibling check (no competing PR)
gh search prs --repo volcengine/OpenViking --state open task_tracker

Notes

  • 20 LOC additive across two files, pure docs
  • Both EN and ZH follow the existing storage.transaction section template (lead sentence → JSON example → parameter table → usage hint)
  • Default value "memory" is highlighted so single-instance operators upgrading do not feel pressured to flip the backend

@github-actions
Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅

1949 - Fully compliant

Compliant requirements:

  • Document the new storage.task_tracker.backend configuration field
  • Include both English and Chinese documentation
  • Show default value "memory"
  • Explain when to use "persistent" backend
⏱️ 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 db3d5db 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
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