Skip to content

Complete stable API documentation and release history #63

Description

@stefan-jansen

Findings: BR-003, BR-029.

Document the complete stable compatibility inventory by user task, execute critical documentation
code, align schema and callback descriptions with runtime, and regenerate release history through
the stable candidate using the authoritative process.

Primary surfaces: README, MkDocs guides and API reference, examples, documentation tests, generated
changelog inputs and release notes.

Acceptance:

  • Every stable callback, config field, Broker operation, result operation, ordering rule,
    limitation, and error mode is documented.
  • Critical Python and shell examples execute in CI against the installed candidate wheel.
  • Quickstart and detailed feed requirements agree with runtime validation.
  • Generated release history covers beta 18 through the stable candidate with compatibility impact.

Dependencies: Issues 7, 12, 19, and 22.


Plan reference: /home/stefan/ml4t/libraries/ml4t-backtest-dev/.workspace/work/backtest-stable-release/milestone-4/plan.md - Issue 23 in milestone 0.1.0-m4 - Maintainability, performance, and adoption.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions