docs(readme): document Scheduled Research usage#288
Merged
Conversation
The scheduled-research feature (#254/#278) shipped without user-facing docs, so users couldn't tell how to drive it. Add a "Scheduled research" subsection to the API Server section plus the three /scheduled-runs endpoint rows in the endpoint table, in en/zh/ja/ko/ar: the VIBE_TRADING_ENABLE_SCHEDULER flag, the interval-ms / 5-field-cron schedule format, and create/list/cancel curl examples.
2 tasks
warren618
added a commit
that referenced
this pull request
Jun 23, 2026
…Bridge / Research Delivery) (#297) Mark Research Autopilot (Phase 1-3, #260/#267), the local Data Bridge loader (#252), and the scheduled-research scheduler/executor (#272/#278/#288) as shipped in the Roadmap status column across all 5 READMEs. Feature descriptions left intact so SQL connectors and multi-channel outbound delivery still read as pending. Closes #294.
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
1 participant
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
The scheduled-research feature (#254, shipped in #278) had no user-facing docs, so users couldn't tell how to drive it — see #254 where the original requester asked "how to use this?".
This adds a concise Scheduled research subsection to the API Server section in all 5 READMEs (en/zh/ja/ko/ar), plus the three
/scheduled-runsrows in the endpoint table.What's documented
VIBE_TRADING_ENABLE_SCHEDULER=1to start the background executor (off by default) — verified atagent/api_server.py:634(@app.on_event("startup")).scheduleformat: bare integer = interval in milliseconds, or a 5-field cron — verified inagent/src/scheduled_research/models.py:validate_schedule.POST/GET/DELETE /scheduled-runscurl examples — verified against the endpoint handlers inagent/api_server.py.API_AUTH_KEYdeployments; jobs persist under~/.vibe-trading/.Test Plan