Skip to content

docs(data): clarify A-share source installation and fallback - #2138

Merged
he-yufeng merged 2 commits into
HKUDS:mainfrom
remote-controlled-man:codex/prflow-c6d51669c9c1
Nov 1, 2026
Merged

he-yufeng merged 2 commits into
HKUDS:mainfrom
remote-controlled-man:codex/prflow-c6d51669c9c1

Conversation

@remote-controlled-man

Copy link
Copy Markdown
Contributor

Summary

  • Align the English/Chinese Wiki and bundled mootdx skill with the actual A-share fallback chain, keeping mootdx documented as a legacy explicit-only source.
  • Explain which sources ship in the base install and how pip/uv tool users can add the optional BaoStock daily-bar source with [ashare], retaining existing extras and --with requirements when rebuilding a uv tool environment.
  • Clarify the limits of startup preflight and SDK presence. Refresh the wiki's shared cache token across its pages, imports and generator as required by wiki/README.md.

Why

Refs #2121. Runtime retirement already landed in #1730, and the README's chain is current, but the Wiki still lists mootdx in automatic fallback and the skill's later instructions contradict its own retirement notice. A user can therefore expect a default-installed source that is neither installed nor part of the default chain.

The installation guidance was checked against pyproject.toml, published 0.1.18 metadata, loader availability checks and the installed uv command help. BaoStock is optional and daily-only; installing the legacy mootdx SDK does not guarantee TDX protocol compatibility.

Validation

  • All 18 declared checks pass on the final commit and environment.
  • Complete Wiki validation: eight JavaScript syntax checks; English/Chinese parity (17 pages, 98 entries); locale JSON; shared chrome/cache consistency (9 pages); i18n/Jinja2 template checks (108 keys, 22 sources); social-card metadata; required static files and blocked-host checks.
  • Private-files gate, all seven grep gates, generator Ruff, generator Black changed-line check, and git diff --check pass. The grep gate retains its existing llm.py environment-access warnings.
  • Local tools: Node 24.21.0 and Python 3.12. The upstream Wiki job uses Node 22; no new JavaScript APIs were introduced.

No full application dependency installation, backend/frontend application suite, live market-data request, model call, Alpha Library export or deployment was run. The Alpha Library's content and template structure are unchanged; its only modification is the shared cache token.

Scope and rollback

Five files change explanatory text. The remaining sixteen wiki files only replace 20261021 with 20261101, keeping the site's single cache token consistent. Dependencies, loader behavior, preflight output, broker and credential handling are unchanged. Revert the two PR commits to roll back.

  • DCO sign-off included.
  • English and Chinese guidance updated together.
  • No credentials or runtime data included.

Signed-off-by: Steven Huang <134844631+remote-controlled-man@users.noreply.github.com>
Signed-off-by: Steven Huang <134844631+remote-controlled-man@users.noreply.github.com>
Copilot AI balanced review requested due to automatic review settings November 1, 2026 03:56

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 insufficient remaining quota. Try requesting a review at a lower effort level.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing.

@he-yufeng he-yufeng left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I checked the full diff against the loader and packaging source. The A-share chain in README.md and the two Wiki locales now matches the registry: mootdx is absent from automatic fallback, baostock sits behind the optional ashare extra, and the skill text no longer tells users to install a retired source by default. The uv guidance preserves existing extras and --with requirements, and I confirmed --force and --with are valid uv tool install flags.

Verification run on ee9b9b0ec3363f37bf2f0b7db700481f3c092a11: sync_site_chrome.py --check passes for 9 pages, check_docs_parity.mjs passes with 17 pages and 98 entries per language, check_i18n.py passes with 108 keys across 22 sources, ci_private_files_gate.py and git diff --check pass, and node --check passes for every changed JavaScript module. CI is green on all eleven checks.

This closes the documentation mismatch in #2121 without changing runtime behavior. Approving.

@he-yufeng
he-yufeng merged commit 22c61e7 into HKUDS:main Nov 1, 2026
11 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.

3 participants