docs: sync specs to implemented state, remove max_startup_latency_seconds - #116
Merged
Conversation
…onds Removes the max_startup_latency_seconds config field (SC-002's own description showed it only gated a warning, never blocked or skipped anything) from AlphorynConfig, scheduler.wait_for_candle_close, the example config, and tests. Also brings the specs/ folder back in line with the actual codebase, which had drifted significantly: - ETF -> ticker terminology finished in contracts/agents.md, contracts/report-context.md, and research.md (PR #99 covered the codebase but missed these three spec docs) - data-model.md's Session table and SignalSnapshot corrected to match the real generalized N-ticker schema (ticker_decisions JSON blob, signals: dict[str, AssetSignals]) instead of stale fixed ticker1_*/ticker2_* fields - contracts/agents.md corrected to the real AssetDecision/SessionDecision dataclasses and execution/telemetry behavior - contracts/cli.md and quickstart.md corrected to the real --tickers flag (was documented as --etf1/--etf2) - contracts/config-schema.md corrected to the real tickers: list[str] config shape - research.md's telemetry event table corrected to match what's actually emitted, with known gaps flagged (execution/agent.py has no telemetry wired in; EVENT_TYPES is missing EVALUATION_FAILED) - plan.md skill paths corrected to match actual hyphenated directories
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
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
max_startup_latency_secondsconfig field entirely (it only gated a warning during candle-boundary alignment; never blocked or skipped a session) fromAlphorynConfig,Scheduler.wait_for_candle_close,config.json.example, and tests.specs/001-etf-paper-trading-agent/back in line with the actual implemented codebase, which had drifted in several places:contracts/agents.md,contracts/report-context.md, andresearch.md(PR Generalise ETF terminology to ticker/asset throughout codebase #99 covered the codebase but missed these three spec docs —checklists/requirements.mdhad a stale claim that this was already done).data-model.md'sSessiontable andSignalSnapshotto match the real generalized N-ticker schema (ticker_decisionsJSON blob,signals: dict[str, AssetSignals]) instead of stale fixedticker1_*/ticker2_*fields.contracts/agents.mdto the realAssetDecision/SessionDecisiondataclasses and execution/telemetry behavior.contracts/cli.mdandquickstart.mdto the real--tickersflag (was documented as--etf1/--etf2).contracts/config-schema.mdto the realtickers: list[str]config shape.research.md's telemetry event table to match what's actually emitted, flagging known implementation gaps (execution/agent.pyhas noTelemetryLoggerwired in;EVENT_TYPESis missingEVALUATION_FAILED).plan.mdskill paths to the real hyphenated directory names.tasks.mdwas deliberately left untouched — it's a completed historical task log with[x]checkboxes, not a living spec.Test plan
ruff check .— all checks passedpytest --cov=alphoryn— 444 passed, 100% coverage