Skip to content

Complete task-first Live documentation and verified book links #105

Closed

Description

@stefan-jansen

Goal

Readers can complete Live's principal supported workflows with the released API, verify the result, and open relevant public book files directly.

Scope

  • Inventory each principal supported capability against a task guide, public API reference, runnable example, and relevant book file; mark experimental and unsupported boundaries.
  • Provide a completed first shadow-mode workflow, preferably without credentials if the existing public API supports it.
  • Repair the Book Guide's stale paths, pin all direct links to one checked public book commit, verify what each file teaches, and add reciprocal task-guide links.
  • Review broker/feed maturity, risk controls, restart behavior, and the backtest-to-live handoff.
  • Run wheel-installed examples, strict MkDocs and library quality gates, and rendered/internal-link checks. Report external-service verification limits.

Acceptance

The documentation PR records the inventory, executed examples, book revision and path checks, link and render checks, quality-gate results, and remaining exceptions. Keep private review evidence in ml4t/live-dev.

Source: ml4t/ecosystem#44 documentation standard and the 2026-09-24 six-library documentation review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions