Skip to content

docs: isolate the published-package quickstart - #127

Closed
stefan-jansen wants to merge 2 commits into
mainfrom
docs/isolated-published-quickstart
Closed

stefan-jansen wants to merge 2 commits into
mainfrom
docs/isolated-published-quickstart

Conversation

@stefan-jansen

Copy link
Copy Markdown
Contributor

The published-package quickstart can reuse an existing checkout's editable environment despite --no-project. Add --isolated so the documented command selects the published dependency set consistently, and explain the flag.

Closes #126.

Executed public-workflow evidence:

  • The original invocation with import provenance printed Live 0.1.3.dev11+gd8351e3 from checkout/src, with Backtest 0.1.0 and Specs 0.1.1. This fails the guide's published-package contract when an editable environment exists.
  • With --isolated, the same dependency/import probe printed Live 0.1.2, Backtest 0.1.12 and Specs 0.1.5 from a cached environment's site-packages, outside the checkout.
  • The complete corrected command uv run --isolated --no-project --with ml4t-live python examples/shadow_mode_demo.py completed all 65 synthetic bars with exit 0 and Finished shadow mode demo. final_positions=flat. No runtime degradation, traceback or venue submission occurred. The example's raw broker rejects venue submission.
  • At dd8d002, strict MkDocs, 130 source-link checks and commit hooks passed. Current-head hosted qualification must pass before merge.

The change affects only the quickstart command and its explanation. No runtime, release or deployment change is included.

AI assistance: Codex executed the original and corrected public workflows, checked real import provenance, updated the guide and ran documentation verification.

Copilot AI balanced review requested due to automatic review settings October 17, 2026 14:21

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@stefan-jansen stefan-jansen added type: documentation Documentation content or process priority: normal Normal planned work status: accepted Accepted for implementation compatibility: none No known compatibility impact labels Oct 17, 2026
@stefan-jansen

Copy link
Copy Markdown
Contributor Author

Superseded by the combined maintainer-directed maintenance PR #121 to avoid qualifying and merging this queue separately. This PR head and its regression/documentation evidence are preserved in #121 and in a verified recovery archive. The accepted issue remains open until the combined fix lands; this closure does not claim the fix is merged. Follow-up work continues in #121.

@stefan-jansen
stefan-jansen deleted the docs/isolated-published-quickstart branch October 18, 2026 00:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

compatibility: none No known compatibility impact priority: normal Normal planned work status: accepted Accepted for implementation type: documentation Documentation content or process

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Isolate the published-package quickstart from checkout environments

2 participants