docs: MT5 host-setup onboarding - #10
Merged
Merged
Conversation
Reintroduces the dedicated-terminal prerequisite and first-run ritual the README dropped during the port from mt5-pnl, adapted to PyPI install, renamed commands, and manual-only v1. Docs-only. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Adds a CONTRIBUTING.md "Smoke-test a real export" section to the spec: the from-clone export check plus the stronger pre-publish wheel-install check, linking the new README host-prep section. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #10 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 7 7
Lines 462 462
Branches 46 46
=========================================
Hits 462 462 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
1 participant
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.
Reintroduces the MT5 host-preparation guidance the README dropped during the port from
mt5-pnl, adapted to this repo (PyPI install, renamed commands, mandatory encryption, manual-only v1).Changes
(-10005, 'IPC timeout')failure mode you hit if you skip it, and where to findterminal_path/login/server.uvbootstrap; Quick start gains a "once the host is prepared" prerequisite lead-in.terminal_pathexamples — the README Configuration block (C:\mt5-poller\) andconfig.example.yaml(the defaultC:\Program Files\MetaTrader 5\, almost certainly the user's EA terminal) — to a single dedicatedC:\Program Files\MT5 Exporter\terminal64.exe.Docs only — no code, schema, or tests changed.
Spec:
docs/superpowers/specs/2026-06-08-host-setup-onboarding-docs-design.mdPlan:
docs/superpowers/plans/2026-06-08-host-setup-onboarding-docs.md🤖 Generated with Claude Code