docs: Add Chinese API documentation and a commercialization roadmap, alongside minor formatting updates to the main README.

This commit is contained in:
2569718930@qq.com
2026-03-11 11:24:41 +08:00
parent 44af26da70
commit 6273768cc2
4 changed files with 76 additions and 76 deletions
+24 -24
View File
@@ -18,15 +18,15 @@ Official dashboard: [polyweather-pro.vercel.app](https://polyweather-pro.vercel.
mindmap mindmap
root((PolyWeather Pro)) root((PolyWeather Pro))
Data Layer Data Layer
METAR(Aviation Weather / METAR) "METAR(Aviation Weather / METAR)"
MGM(Turkey MGM) "MGM(Turkey MGM)"
Station 17130(Ankara Center 17130) "Station 17130(Ankara Center 17130)"
Open-Meteo Open-Meteo
weather.gov(US cities) "weather.gov(US cities)"
Polymarket(P0 Read-only) "Polymarket(P0 Read-only)"
Analysis Layer Analysis Layer
DEB(Dynamic Error Balancing) "DEB(Dynamic Error Balancing)"
Probability Engine(mu + buckets) "Probability Engine(mu + buckets)"
Trend Engine Trend Engine
Risk Profiles Risk Profiles
Mispricing Radar Mispricing Radar
@@ -36,9 +36,9 @@ mindmap
Telegram Bot Telegram Bot
Alert Push Alert Push
Ops Layer Ops Layer
Docker Compose(VPS backend + bot) "Docker Compose(VPS backend + bot)"
Vercel(frontend) "Vercel(frontend)"
Cache + force_refresh "Cache + force_refresh"
Speed Insights Speed Insights
``` ```
@@ -65,14 +65,14 @@ graph TD
## Current Source Policy ## Current Source Policy
| Domain | Source Policy | | Domain | Source Policy |
| :-- | :-- | | :------------------ | :--------------------------------------------------- |
| Primary observation | Aviation Weather / METAR | | Primary observation | Aviation Weather / METAR |
| Ankara enhancement | MGM + nearby stations, lead station fixed to `17130` | | Ankara enhancement | MGM + nearby stations, lead station fixed to `17130` |
| Forecast baseline | Open-Meteo | | Forecast baseline | Open-Meteo |
| US official context | weather.gov | | US official context | weather.gov |
| Market layer | Polymarket P0 read-only discovery + quotes | | Market layer | Polymarket P0 read-only discovery + quotes |
| Removed source | Meteoblue (fully removed from code and docs) | | Removed source | Meteoblue (fully removed from code and docs) |
## Recent Changes (2026-03-11) ## Recent Changes (2026-03-11)
@@ -114,12 +114,12 @@ npm run build
## Command Surface (Telegram) ## Command Surface (Telegram)
| Command | Purpose | | Command | Purpose |
| :-- | :-- | | :------------- | :---------------------------- |
| `/city <name>` | City real-time analysis | | `/city <name>` | City real-time analysis |
| `/deb <name>` | DEB historical reconciliation | | `/deb <name>` | DEB historical reconciliation |
| `/top` | User leaderboard | | `/top` | User leaderboard |
| `/help` | Help and command usage | | `/help` | Help and command usage |
## Documentation Index ## Documentation Index
+25 -25
View File
@@ -18,27 +18,27 @@
mindmap mindmap
root((PolyWeather Pro)) root((PolyWeather Pro))
数据层 数据层
METAR(Aviation Weather / METAR) "METAR(Aviation Weather / METAR)"
MGM(土耳其 MGM) "MGM(土耳其 MGM)"
安卡拉主站(17130 Center) "安卡拉主站(17130 Center)"
Open-Meteo Open-Meteo
weather.gov(美国城市) "weather.gov(美国城市)"
Polymarket(P0 只读) "Polymarket(P0 只读)"
分析层 分析层
DEB(动态误差平衡) "DEB(动态误差平衡)"
概率引擎(mu + 桶分布) "概率引擎(mu + 桶分布)"
趋势引擎 趋势引擎
城市风险档案 城市风险档案
错价雷达 错价雷达
交付层 交付层
FastAPI FastAPI
Next.js 仪表盘 "Next.js 仪表盘"
Telegram Bot "Telegram Bot"
预警推送 预警推送
运维层 运维层
Docker Compose(VPS) "Docker Compose(VPS)"
Vercel(前端) "Vercel(前端)"
缓存 + force_refresh "缓存 + force_refresh"
Speed Insights Speed Insights
``` ```
@@ -65,14 +65,14 @@ graph TD
## 当前数据源口径 ## 当前数据源口径
| 领域 | 当前口径 | | 领域 | 当前口径 |
| :-- | :-- | | :------------- | :-------------------------------- |
| 主观测源 | Aviation Weather / METAR | | 主观测源 | Aviation Weather / METAR |
| Ankara 增强 | MGM + 周边站,领先站固定 `17130` | | Ankara 增强 | MGM + 周边站,领先站固定 `17130` |
| 预报基线 | Open-Meteo | | 预报基线 | Open-Meteo |
| 美国官方语义层 | weather.gov | | 美国官方语义层 | weather.gov |
| 市场层 | Polymarket P0 只读发现 + 报价 | | 市场层 | Polymarket P0 只读发现 + 报价 |
| 已移除 | Meteoblue(代码与文档已全部移除) | | 已移除 | Meteoblue(代码与文档已全部移除) |
## 最近更新(2026-03-11 ## 最近更新(2026-03-11
@@ -113,12 +113,12 @@ npm run build
## Telegram 命令 ## Telegram 命令
| 命令 | 用途 | | 命令 | 用途 |
| :-- | :-- | | :------------- | :----------- |
| `/city <name>` | 城市实时分析 | | `/city <name>` | 城市实时分析 |
| `/deb <name>` | DEB 历史对账 | | `/deb <name>` | DEB 历史对账 |
| `/top` | 用户排行榜 | | `/top` | 用户排行榜 |
| `/help` | 帮助说明 | | `/help` | 帮助说明 |
## 文档索引 ## 文档索引
+14 -14
View File
@@ -23,32 +23,32 @@
mindmap mindmap
root((PolyWeather API)) root((PolyWeather API))
城市列表 城市列表
GET /api/cities "GET /api/cities"
城市主数据 城市主数据
GET /api/city/{name} "GET /api/city/{name}"
GET /api/city/{name}/summary "GET /api/city/{name}/summary"
GET /api/city/{name}/detail "GET /api/city/{name}/detail"
历史数据 历史数据
GET /api/history/{name} "GET /api/history/{name}"
关键对象 关键对象
current current
forecast forecast
probabilities(mu + distribution) "probabilities(mu + distribution)"
multi_model / multi_model_daily multi_model / multi_model_daily
market_scan(P0 只读) "market_scan(P0 只读)"
``` ```
--- ---
## 3. 接口总览 ## 3. 接口总览
| 接口 | 方法 | 用途 | | 接口 | 方法 | 用途 |
| :-- | :-- | :-- | | :------------------------- | :--- | :------------------------------------ |
| `/api/cities` | GET | 城市清单与地图基础信息 | | `/api/cities` | GET | 城市清单与地图基础信息 |
| `/api/city/{name}` | GET | 城市主分析数据(侧栏/今日分析主来源) | | `/api/city/{name}` | GET | 城市主分析数据(侧栏/今日分析主来源) |
| `/api/city/{name}/summary` | GET | 轻量摘要(首屏预热/低开销更新) | | `/api/city/{name}/summary` | GET | 轻量摘要(首屏预热/低开销更新) |
| `/api/city/{name}/detail` | GET | 聚合详情 + Polymarket P0 只读市场层 | | `/api/city/{name}/detail` | GET | 聚合详情 + Polymarket P0 只读市场层 |
| `/api/history/{name}` | GET | 历史对账数据 | | `/api/history/{name}` | GET | 历史对账数据 |
--- ---
+13 -13
View File
@@ -29,8 +29,8 @@ mindmap
Dashboard 5 USD Dashboard 5 USD
Bundle 5.5 USD Bundle 5.5 USD
Access Control Access Control
Manual activation(P1) "Manual activation(P1)"
Wallet/USDC detection(P2) "Wallet/USDC detection(P2)"
Entitlement middleware Entitlement middleware
Growth Growth
Accuracy reports Accuracy reports
@@ -42,11 +42,11 @@ mindmap
## 3. Packaging and Pricing ## 3. Packaging and Pricing
| Tier | Price | Value | | Tier | Price | Value |
| :-- | :-- | :-- | | :--------------- | :----------- | :---------------------------------------- |
| Telegram Channel | $1 / month | Low-noise proactive signal feed | | Telegram Channel | $1 / month | Low-noise proactive signal feed |
| Web Dashboard | $5 / month | Full multi-model context + reconciliation | | Web Dashboard | $5 / month | Full multi-model context + reconciliation |
| VIP Bundle | $5.5 / month | Dashboard + signal stream | | VIP Bundle | $5.5 / month | Dashboard + signal stream |
Payment direction: Payment direction:
@@ -85,12 +85,12 @@ graph LR
## 5. Technical Dependencies for Revenue ## 5. Technical Dependencies for Revenue
| Dependency | Why it matters | | Dependency | Why it matters |
| :-- | :-- | | :------------------- | :--------------------------------------------------------------- |
| Entitlement guard | Prevents unpaid dashboard/API access | | Entitlement guard | Prevents unpaid dashboard/API access |
| Subscriber store | Persistent paid user state | | Subscriber store | Persistent paid user state |
| Audit trail | Explains why each alert fired | | Audit trail | Explains why each alert fired |
| Observability | Detects degradation before churn | | Observability | Detects degradation before churn |
| Frontend performance | Impacts conversion and retention (Speed Insights now integrated) | | Frontend performance | Impacts conversion and retention (Speed Insights now integrated) |
--- ---