From 35345a1b0406e4d1e4008c5795973d6b3a6d2c2f Mon Sep 17 00:00:00 2001 From: "2569718930@qq.com" <2569718930@qq.com> Date: Wed, 11 Mar 2026 11:42:16 +0800 Subject: [PATCH] docs: Introduce commercialization and technical debt documentation in English and Chinese, and update README diagram formatting. --- README.md | 46 +++++++++++++++++++-------------------- README_ZH.md | 46 +++++++++++++++++++-------------------- docs/COMMERCIALIZATION.md | 32 +++++++++++++-------------- docs/TECH_DEBT.md | 24 ++++++++++---------- docs/TECH_DEBT_ZH.md | 24 ++++++++++---------- 5 files changed, 86 insertions(+), 86 deletions(-) diff --git a/README.md b/README.md index 038ccee4..35026a5e 100644 --- a/README.md +++ b/README.md @@ -17,29 +17,29 @@ Official dashboard: [polyweather-pro.vercel.app](https://polyweather-pro.vercel. ```mermaid mindmap root((PolyWeather Pro)) - Data Layer - [METAR (Aviation Weather / METAR)] - [MGM (Turkey MGM)] - [Station 17130 (Ankara Center 17130)] - Open-Meteo - [weather.gov (US cities)] - [Polymarket (P0 Read-only)] - Analysis Layer - [DEB (Dynamic Error Balancing)] - [Probability Engine (mu + buckets)] - Trend Engine - Risk Profiles - Mispricing Radar - Delivery Layer - FastAPI - Next.js Dashboard - Telegram Bot - Alert Push - Ops Layer - [Docker Compose (VPS backend + bot)] - [Vercel (frontend)] - [Cache + force_refresh] - Speed Insights + "Data Layer" + "METAR (Aviation Weather / METAR)" + "MGM (Turkey MGM)" + "Station 17130 (Ankara Center 17130)" + "Open-Meteo" + "weather.gov (US cities)" + "Polymarket (P0 Read-only)" + "Analysis Layer" + "DEB (Dynamic Error Balancing)" + "Probability Engine (mu + buckets)" + "Trend Engine" + "Risk Profiles" + "Mispricing Radar" + "Delivery Layer" + "FastAPI" + "Next.js Dashboard" + "Telegram Bot" + "Alert Push" + "Ops Layer" + "Docker Compose (VPS backend + bot)" + "Vercel (frontend)" + "Cache + force_refresh" + "Speed Insights" ``` ## Architecture diff --git a/README_ZH.md b/README_ZH.md index 5992cbcb..a165a1f8 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -17,29 +17,29 @@ ```mermaid mindmap root((PolyWeather Pro)) - 数据层 - [METAR (Aviation Weather / METAR)] - [MGM (土耳其 MGM)] - [安卡拉主站 (17130 Center)] - Open-Meteo - [weather.gov (美国城市)] - [Polymarket (P0 只读)] - 分析层 - [DEB (动态误差平衡)] - [概率引擎 (mu + 桶分布)] - 趋势引擎 - 城市风险档案 - 错价雷达 - 交付层 - FastAPI - [Next.js 仪表盘] - [Telegram Bot] - 预警推送 - 运维层 - [Docker Compose (VPS)] - [Vercel (前端)] - [缓存 + force_refresh] - Speed Insights + "数据层" + "METAR (Aviation Weather / METAR)" + "MGM (土耳其 MGM)" + "安卡拉主站 (17130 Center)" + "Open-Meteo" + "weather.gov (美国城市)" + "Polymarket (P0 只读)" + "分析层" + "DEB (动态误差平衡)" + "概率引擎 (mu + 桶分布)" + "趋势引擎" + "城市风险档案" + "错价雷达" + "交付层" + "FastAPI" + "Next.js 仪表盘" + "Telegram Bot" + "预警推送" + "运维层" + "Docker Compose (VPS)" + "Vercel (前端)" + "缓存 + force_refresh" + "Speed Insights" ``` ## 系统架构 diff --git a/docs/COMMERCIALIZATION.md b/docs/COMMERCIALIZATION.md index 02d71a1b..ba938d40 100644 --- a/docs/COMMERCIALIZATION.md +++ b/docs/COMMERCIALIZATION.md @@ -20,22 +20,22 @@ It is a decision-support layer for temperature-settlement markets: ```mermaid mindmap root((PolyWeather Monetization)) - Product - Telegram Signal Channel - Web Dashboard - VIP Bundle - Pricing - [Entry 1 USD] - [Dashboard 5 USD] - [Bundle 5.5 USD] - Access Control - [Manual activation (P1)] - [Wallet/USDC detection (P2)] - Entitlement middleware - Growth - Accuracy reports - Retention analytics - User preference center + "Product" + "Telegram Signal Channel" + "Web Dashboard" + "VIP Bundle" + "Pricing" + "Entry 1 USD" + "Dashboard 5 USD" + "Bundle 5.5 USD" + "Access Control" + "Manual activation (P1)" + "Wallet/USDC detection (P2)" + "Entitlement middleware" + "Growth" + "Accuracy reports" + "Retention analytics" + "User preference center" ``` --- diff --git a/docs/TECH_DEBT.md b/docs/TECH_DEBT.md index 1c5fac00..e0bdb5b9 100644 --- a/docs/TECH_DEBT.md +++ b/docs/TECH_DEBT.md @@ -9,18 +9,18 @@ Purpose: keep engineering debt explicit while shipping production features. ```mermaid mindmap root((Tech Debt)) - Architecture - Monolithic bot entry - Shared runtime coupling - Product Infra - Entitlement hardening - Subscription persistence - Quality - Replay harness - Broader regression tests - Observability - Alert evidence trace - SLO dashboards + "Architecture" + "Monolithic bot entry" + "Shared runtime coupling" + "Product Infra" + "Entitlement hardening" + "Subscription persistence" + "Quality" + "Replay harness" + "Broader regression tests" + "Observability" + "Alert evidence trace" + "SLO dashboards" ``` Current system health estimate: **84% stable / 16% debt**. diff --git a/docs/TECH_DEBT_ZH.md b/docs/TECH_DEBT_ZH.md index 30b3cf2c..36e7318f 100644 --- a/docs/TECH_DEBT_ZH.md +++ b/docs/TECH_DEBT_ZH.md @@ -9,18 +9,18 @@ ```mermaid mindmap root((技术债)) - 架构层 - 机器人入口过于集中 - 共享运行时耦合 - 产品基础设施 - 订阅权限一致性 - 付费用户持久化 - 质量保障 - 回放测试能力 - UI 回归覆盖不足 - 可观测性 - 告警证据链 - SLO 看板 + "架构层" + "机器人入口过于集中" + "共享运行时耦合" + "产品基础设施" + "订阅权限一致性" + "付费用户持久化" + "质量保障" + "回放测试能力" + "UI 回归覆盖不足" + "可观测性" + "告警证据链" + "SLO 看板" ``` 当前系统健康度估计:**84% 稳定 / 16% 技术债**。