docs: sync documentation with current codebase (v1.0.x)#36
Merged
Conversation
- Update SECURITY.md supported version from 0.1.x to 1.0.x (root + docs) - Update utility count from 30+ to 40+ in README.md and README_zh.md - Add Studio CI badge to README_zh.md - Add walk-forward analysis and scientific validation features to READMEs - Replace deprecated fama_french_analysis with simple_factor_analysis across api_reference.md, user_guide.md, tutorials, examples, and Examples.md - Add walk_forward/WFAResult and scientific validation API sections to api_reference.md and user_guide.md - Add glossary terms: bootstrap, Monte Carlo, overfitting, survivorship bias, VaR, CVaR - Update example 09 to use simple_factor_analysis
Copilot created this pull request from a session on behalf of
AlanFokCo
May 28, 2026 08:11
View session
AlanFokCo
approved these changes
May 28, 2026
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.
Documentation had drifted from the codebase across several dimensions: outdated version references, deprecated API names still used as primary, undocumented public APIs, and incorrect counts.
Fixes
0.1.x→1.0.x30+→40+(actual: 45); added missing Studio CI badge to Chinese README; added walk-forward analysis and scientific validation to feature listsfama_french_analysis→simple_factor_analysis: Updated acrossapi_reference.md,user_guide.md,tutorials/03_backtesting.md,tutorials/04_strategy_optimization.md,examples/09_attribution_analysis.py, andexamples/Examples.md. Added deprecation warnings and model limitation notes (not a true Fama-French 3-factor model).New documentation for previously undocumented APIs
api_reference.md: Added Walk-Forward Analysis API (walk_forward,WFAResult) and Scientific Validation API (validate_backtest,ValidationConfig, submodule reference table). Updated import appendix.user_guide.md: Added §13A (Walk-Forward Analysis) and §13B (Scientific Validation) with usage examplesglossary.md: Added 6 terms — bootstrap, CVaR, Monte Carlo simulation, overfitting, survivorship bias, VaRExample of updated usage
Validated with
mkdocs build --strict— builds clean.