Skip to content

Set one verified documentation standard for six ML4T libraries #43

Open

Description

@stefan-jansen

Summary

Define one content and verification standard for the six user-facing ML4T library documentation sites, audit the current state, and hand library-specific remediation to the owning development sidecars.

Observed state

A student found Backtest guidance less clear than the older Quantopian documentation. Backtest has since added a checked tutorial sequence. On 2026-09-24 all six local sites passed strict MkDocs builds, but book navigation, example evidence, and first-run experience remain uneven. The dated review and standard are in draft PR #44.

Expected state

A reader of any of the six sites can complete a principal task, verify the result, find the released API, and reach a verified relevant book example. The sites explain factual overlap and differences with maintained Zipline, Alphalens, and Pyfolio workflows where relevant.

Work sequence

  1. Review and merge the shared standard and dated audit in PR Define six-library documentation quality standard #44.
  2. Backtest checks the new User Guide against its released public interface, keeping its executable-example and checked-link gates as the initial quality reference.
  3. Engineer repairs outdated book chapter paths and notebook mappings. Diagnostic, Live, Data, and Models then verify and link their own book examples at fixed companion revisions.
  4. Each owning library inventories principal capabilities against task guides, the released API reference, runnable examples, and book examples where relevant. Each library opens its own issue and PR for user-facing changes.
  5. The ecosystem reruns a six-site review after the library PRs land, including deployed routes and release identity.
  6. Backtest, Diagnostic, and Engineer document task-level transitions from Zipline, Pyfolio, and Alphalens. Maintainers of the older repositories may add scoped successor notices after those migrations are verified.

Six library-specific handoff prompts were committed to the private development sidecars on 2026-09-24.

Scope and compatibility

This issue owns the shared ecosystem standard, review, and coordination. Each public library owns its documentation edits and issue. No runtime compatibility change is expected. Specs remains under the existing release standard but outside this six-site content campaign.

Acceptance

  • The ecosystem standard states measurable reader, example, book-link, predecessor-guidance, discovery, and review requirements.
  • A dated six-site audit records checkout scope, verification results, strengths, and gaps.
  • Each of the six development sidecars has a specific prompt linked to the shared standard.
  • The ecosystem records the library issue and PR outcomes and reruns the six-site review after their changes land.

Activity

  1. added
    priority: highMaterial user impact requiring prompt remediation
    ecosystemTracked by a shared ML4T ecosystem requirement
    on Sep 24, 2026
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

    compatibility: noneNo known compatibility impactecosystemTracked by a shared ML4T ecosystem requirementpriority: highMaterial user impact requiring prompt remediationstatus: acceptedAccepted for implementationtype: documentationDocumentation content or process

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions