wehub-resource-sync
7.6 KiB
7.6 KiB
English Documentation Index
This is the entry point for project documentation. The README covers the project overview and quick start; detailed setup, configuration, deployment, feature usage, and troubleshooting docs are linked below.
For Chinese documentation, see docs/INDEX.md.
Choose By Goal
| I want to | Start with | Then read |
|---|---|---|
| Understand what the project does | README (EN) | Full Guide (EN) |
| Run the project for the first time | README (EN) | Full Guide (EN) |
| Configure model providers | LLM Config Guide (EN) | Provider Configuration Guide  (Chinese-only) |
| Configure notifications | Notification Baseline (Chinese-only) |
Full Guide (EN) |
| Deploy to a server or cloud platform | Deploy Guide (EN) | Cloud WebUI Deployment (Chinese-only), Zeabur Deployment (Chinese-only) |
| Use Bot / IM integrations | Bot Commands (EN) | Bot Platform Docs (Chinese-only) |
| Troubleshoot runtime issues | FAQ (EN) | Changelog |
| Troubleshoot data-source failures | Data-source stability diagrams (Chinese-only) |
FAQ (EN) |
| Contribute code or docs | Contributing Guide (EN) | API Spec |
Getting Started
| Document | Contents |
|---|---|
| README (EN) | Project overview, key features, quick start, sample output |
| Full Guide (EN) | Environment setup, run modes, configuration, deployment paths, and common issues |
| FAQ (EN) | Common configuration, model, notification, deployment, and runtime issues |
| Data-source stability diagrams (Chinese-only) |
Existing-source routing, fallback chains, and recommended configuration profiles |
| Changelog | Release notes, capability changes, and migration notes |
Configuration
| Document | Contents |
|---|---|
| LLM Config Guide (EN) | Model providers, three-tier configuration, Web settings, and common model setup |
| Provider Configuration Guide (Chinese-only) |
Provider presets, GitHub Actions mapping, error categories, and diagnostics |
| LiteLLM YAML Example | Example LiteLLM multi-provider configuration |
| Notification Baseline (Chinese-only) |
WeChat Work, Feishu, Telegram, Discord, Slack, Email, and other notification channels |
| Tushare Stock List Guide (Chinese-only) |
Tushare stock-list configuration and usage notes |
Usage Topics
| Document | Contents |
|---|---|
| Bot Commands (EN) | Bot commands, webhooks, platform integration, and callback behavior |
| Bot Platform Docs (Chinese-only) |
Feishu, DingTalk, Discord, and related Bot configuration screenshots and notes |
Real-Time Alert Center  (Chinese-only) |
EventMonitor baseline, Web rule management, notification attempts, cooldown state, and phase boundaries |
DecisionSignal Topic  (Chinese-only) |
AI signal fields, API, Web display, alert/notification/portfolio-risk linkage, outcome evaluation, redaction, migration, and rollback |
Analysis Context Pack Contract, Runtime Consumption, And Visibility  (Chinese-only) |
AnalysisContextPack first-scope boundaries, field quality states, P1/P2 internal contracts, P3 prompt-summary consumption, P4 history/API/Web low-sensitivity visibility, P5 data-quality scoring, and P6 migration/rollback notes, plus source anchors; the full guide adds #1386 market-phase analysis, migration, and rollback entry points |
| Image Extraction Prompt (Chinese-only) |
Prompt and boundaries for extracting stock information from images |
| OpenClaw Skill Integration (Chinese-only) |
OpenClaw / Skill external integration notes |
Deployment And Packaging
| Document | Contents |
|---|---|
| Deploy Guide (EN) | Server deployment, Docker, systemd, Supervisor, and related options |
| Cloud WebUI Deployment (Chinese-only) |
Cloud server WebUI access and deployment notes |
| Zeabur Deployment (Chinese-only) |
Zeabur platform deployment |
| Desktop Packaging (Chinese-only) |
Electron desktop app and Web artifact packaging |
Reference And Development
| Document | Contents |
|---|---|
| API Spec | FastAPI OpenAPI artifact |
| Contributing Guide (EN) | Issues, pull requests, tests, documentation sync, and collaboration expectations |
Languages
| Document | Contents |
|---|---|
| Chinese Documentation Index | Chinese documentation entry point |
| Traditional Chinese README | Traditional Chinese project overview and quick start |
China-Market Glossary
| Term | Meaning |
|---|---|
| A-shares | Stocks listed on the Shanghai or Shenzhen stock exchanges, denominated in CNY |
| Northbound capital flow | Net buy/sell flow from foreign investors through Stock Connect programs |
| Dragon-Tiger List | Daily SSE/SZSE disclosure of heavily traded stocks and top trading seats |
| Chip distribution | Cost-basis distribution of outstanding shares, often used to estimate support and resistance |
| Tushare | Chinese financial data API that requires a token |
| AkShare | Open-source Python market data library |
| Baostock | Free Python SDK for historical A-share data |
| WeChat Work | Tencent enterprise messaging platform with webhook notifications |
| Feishu | ByteDance enterprise collaboration platform with webhook notifications |
| PushPlus / ServerChan | Chinese mobile push notification services |