Skip to content

docs: add bilingual beginner guide + reflect the 已注册因子 rename - #24

Merged
agenthaulk merged 1 commit into
mainfrom
feature/newcomer-guide
Jul 17, 2026
Merged

agenthaulk merged 1 commit into
mainfrom
feature/newcomer-guide

Conversation

@agenthaulk

Copy link
Copy Markdown
Owner

Summary

Promotes the illustrated Chinese beginner guide to a tracked doc and links it from the README.

docs/getting_started_zh.md is an end-to-end first-run walkthrough for a newcomer with zero background: what the tool does, 7 core terms, install (Docker / venv), first launch + control token, a UI tour, mining a first factor, and — importantly — a "what actually happens after you click 开始研究" section (parse → confirm → compute → report, whether the LLM was called, where data comes from, how metrics and the backtest read). It ships 7 flow diagrams and an English/Chinese metric glossary.

This PR:

Desensitization

Scanned before tracking — no API keys, no control tokens, no absolute local paths, and no internal-attribution or platform-account material. release_safety_scan.py passes on 278 public files (the guide included) and tests/test_release_cleanliness.py is green.

Promote the illustrated Chinese getting-started guide (docs/getting_started_zh.md)
to a tracked doc: end-to-end first-run walkthrough with 7 flow diagrams,
metric中英对照, and a section on switching the LLM provider from the Web UI.
Update its tab reference to the renamed 已注册因子 label, drop it from
.dockerignore so it ships with the other docs/, and link it from the README
docs list.
@agenthaulk
agenthaulk merged commit 390a13a into main Jul 17, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant