Repository navigation
Add a navigable and audited Backtest User Guide - #121
Merged
Merged
Conversation
The published guide lacked a direct overview, and the homepage convenience example referenced undefined names. Link the existing task pages and verify a complete example against the documentation checker.
The old result guide referenced an undefined analysis variable and omitted the visualization dependency. Run a complete HTML tearsheet example against the installed wheel in CI and release verification.
Explain the prerequisites for reference snippets on each topic page. Remove absolute claims about framework equivalence, vectorization, and an incorrect test count.
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
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.
Why
The 0.1.9 documentation release has a User Guide tab but no overview page or clear path from the Book Guide. The homepage also contains a
run_backtestexample with undefined names. The Results guide's HTML tearsheet example uses an undefined value and omits its visualization dependency. This PR is the first corrective pass for #120.Changes
/user-guide/with task and asset-setting routes to the existing topic pages and complete tutorials; link it from the homepage and Book Guide.run_backtestexample.ml4t-diagnostic[viz]==0.1.4; run it against the installed wheel in CI and release verification.Verification
uv run mkdocs build --strictpassed. The rendered guide link checker resolved 2,005 content links, including page and section anchors, and checked 29 external destinations. It now runs in PR CI and the docs workflow.pre-commit run --all-filespassed.0.1.10.dev3+gb2d2702dfwheel and ran every default documentation example. After installingml4t-diagnostic[viz]==0.1.4, the diagnostic handoff and full HTML tearsheet examples passed.Issue #120 remains open until the reviewed guide is merged, deployed, and checked at the canonical route. This PR should not be read as a claim of 100% documentation correctness.