diff --git a/.gitignore b/.gitignore index b51b419a..8aa341bb 100644 --- a/.gitignore +++ b/.gitignore @@ -17,3 +17,6 @@ npm-debug.log* yarn-debug.log* yarn-error.log* pnpm-debug.log* + +# Generated bilingual local review site. Never publish this directory. +.preview-prediction/ diff --git a/README.md b/README.md index e12fd80c..c3771162 100644 --- a/README.md +++ b/README.md @@ -110,3 +110,29 @@ Copyright (c) 2026 6MM. All rights reserved. This repository is public for documentation collaboration, review, and issue tracking. It does not grant an open source or Creative Commons license for the documentation, downloads, or brand materials. + +## Local prediction content review + +The Prediction section adds 17 pages across all 20 configured languages. +English and Simplified Chinese are authored together; Traditional Chinese is converted from the Chinese draft, and the other 17 locales use +machine-assisted translation and need native-language editorial review before release. +Review the business-rule checklist in `docs/prediction-content-review.md` before publication. + +```bash +npm ci +npm run check +npm run preview:prediction +``` + +Open `http://127.0.0.1:3010/zh-CN/prediction/overview` (Chinese) or +`http://127.0.0.1:3010/prediction/overview` (English), then use the existing language menu. +The preview runs the normal Fern renderer with all configured languages. +Ports default to 3010/3011; use `npm run preview:prediction -- --port=3012 --backend-port=3013` +if needed. Nothing is published by this command. + +The old Edge translation auth endpoint returned HTTP 404. The generator now defaults +to the public Google dictionary translation endpoint, with request throttling, +bounded retries, and protected-token validation. This unofficial endpoint may change; +`DOCS_TRANSLATION_PROVIDER=edge` retains the previous provider for environments where it works. +Existing manifest hashes still control incremental generation; do not refresh them to hide +missing translations. The full `npm run check` validates all 20 locales. diff --git a/docs/prediction-content-review.md b/docs/prediction-content-review.md new file mode 100644 index 00000000..ff3c0fc7 --- /dev/null +++ b/docs/prediction-content-review.md @@ -0,0 +1,32 @@ +# Prediction documentation review (local draft) + +This file is an editorial checklist and is not included in the public navigation. + +## Evidence + +- Local total-admin: `/home/rog/6mm-console-project/6mm-admin-console`. +- `prediction-list-schema.js`: three games, seven canonical query pages, fields and display states. +- `app.js`: gameplay configuration around 1856 and 5935; odds around 6143; grid guide around 6315; funding-account definitions around 225–250; risk controls around 6933. +- `BACKEND-INTEGRATION.md`: reporting conventions around 137–141; service-fee category around 72. +- Total-admin uses demo mode and has pre-existing uncommitted edits. It was read only; no production settlement implementation has been verified. + +## Resolve before publication + +1. Equal opening/settlement prices in Up/Down and Custom: outcome, stake treatment and fee treatment. +2. Up/Down odds locking point, funding pool timing, and whether the documented formula exactly matches production. +3. Grid: exact price/time boundary inclusion, crossing/interpolation rules across samples, gaps and finality after a hit. +4. Grid: internal guide gives 10 × 10, 2 seconds per cell, 97%, 1.02x–20x. Public examples deliberately do not promise these production settings. +5. Stored odds precision, display rounding, settlement rounding and currency precision. Corrected the illustrative 100 × 4.85 payout to 485, not 490. +6. Cancellation/amendment policy, refund amount, fee reversals and processing deadlines. +7. Actual service-fee schedule, billing basis and whether amounts shown to users are before/after fees. +8. Partner-specific funding paths and prediction API/Widget availability. No new endpoints or SDK methods are invented. +9. Grid mock history still includes result-cell/final-price terminology; the detailed gameplay guide defines a time-window touch result. Confirm the production contract. +10. Mark-price evidence and the probability estimator implementation need backend review. Public copy describes the model concept, not unverified numerical implementation details. + +## Translation review + +English and Simplified Chinese are authored together. Traditional Chinese is converted from the authored Chinese draft with OpenCC; the other 17 enabled locales are machine-translated with protected links, code, and business terms, then structurally validated. The broken Edge auth endpoint was replaced by a public Google translation adapter. Native-language editorial review remains required, especially for odds, payout, stake, and outcome terminology. Existing approved navigation and entry-page copy is retained outside the new prediction additions. + +## Scope + +17 new pages, a separate Prediction tab, home/trading entry cards, and perpetual-specific scope notes. Keep all changes local until user testing and business review are complete. diff --git a/fern/docs.yml b/fern/docs.yml index 87348cc9..05b5ca43 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -39,6 +39,10 @@ translations: - lang: ar redirects: + - source: "/prediction" + destination: "/prediction/overview" + - source: "/:locale/prediction" + destination: "/:locale/prediction/overview" # Retired locale prefixes preserve inbound links by falling back to the # equivalent English page; they are not published Docs locales. - source: "/uz/:slug*" @@ -86,12 +90,6 @@ redirects: destination: "/security-compliance/overview" - source: "/resources" destination: "/resources/overview" - - source: "/ai-hub/:slug*" - destination: "/developer-api/integration-overview" - permanent: true - - source: "/zh/ai-hub/:slug*" - destination: "/zh-CN/developer-api/integration-overview" - permanent: true - source: "/solutions/license-support" destination: "/security-compliance/license-support" permanent: true @@ -447,16 +445,20 @@ tabs: icon: fa-duotone fa-grid-2 skip-slug: true trading: - display-name: "Trading" + display-name: "Futures Trading" icon: fa-duotone fa-chart-candlestick skip-slug: true + prediction: + display-name: "Prediction" + icon: fa-duotone fa-bullseye + skip-slug: true developers: display-name: "Developers" icon: fa-duotone fa-code skip-slug: true - integration: - display-name: "Integration Guide" - icon: fa-duotone fa-diagram-project + aiHub: + display-name: "AI Hub" + icon: fa-duotone fa-sparkles skip-slug: true sdk: display-name: "SDKs" @@ -546,7 +548,7 @@ navigation: layout: - section: Overview contents: - - page: 6MM Trading Guide + - page: "Introduction to Futures Trading" path: docs/pages/trading/overview.mdx icon: fa-duotone fa-chart-candlestick - section: Trading Basics @@ -593,6 +595,73 @@ navigation: - page: Risk & Liquidations path: docs/pages/trading/risk-and-liquidations.mdx icon: fa-duotone fa-shield-check + - tab: prediction + layout: + - section: "Overview" + contents: + - page: "Prediction Trading" + path: docs/pages/prediction/overview.mdx + icon: fa-duotone fa-bullseye + - section: "Getting Started" + contents: + - page: "Start Prediction Trading" + path: docs/pages/prediction/getting-started.mdx + icon: fa-duotone fa-play + - page: "Prediction Trading Workflow" + path: docs/pages/prediction/workflow.mdx + icon: fa-duotone fa-route + - section: "Game Guides" + contents: + - page: "Up/Down Prediction" + path: docs/pages/prediction/up-down.mdx + icon: fa-duotone fa-chart-line + - page: "Custom Prediction" + path: docs/pages/prediction/custom.mdx + icon: fa-duotone fa-sliders + - page: "Prediction Grid" + path: docs/pages/prediction/grid.mdx + icon: fa-duotone fa-grid-2 + - section: "Prices and Odds" + contents: + - page: "Price Sources and Result Evidence" + path: docs/pages/prediction/price-source.mdx + icon: fa-duotone fa-tower-broadcast + - page: "Prediction Odds Mechanisms" + path: docs/pages/prediction/odds.mdx + icon: fa-duotone fa-gauge-high + - page: "Prediction Payouts and PnL" + path: docs/pages/prediction/returns-pnl.mdx + icon: fa-duotone fa-chart-waterfall + - section: "Orders and Settlement" + contents: + - page: "Prediction Order Rules and Statuses" + path: docs/pages/prediction/orders-statuses.mdx + icon: fa-duotone fa-list-check + - page: "Prediction Result Evaluation and Settlement" + path: docs/pages/prediction/settlement.mdx + icon: fa-duotone fa-clipboard-check + - page: "Refunds, Voids and Exceptions" + path: docs/pages/prediction/refunds-exceptions.mdx + icon: fa-duotone fa-arrow-rotate-left + - section: "Accounts and Funds" + contents: + - page: "Prediction Accounts and Balances" + path: docs/pages/prediction/accounts-balances.mdx + icon: fa-duotone fa-wallet + - page: "Prediction Transfers and Transactions" + path: docs/pages/prediction/transfers-ledger.mdx + icon: fa-duotone fa-arrow-right-arrow-left + - section: "Fees and Risk" + contents: + - page: "Prediction Fees" + path: docs/pages/prediction/fees.mdx + icon: fa-duotone fa-receipt + - page: "Prediction Limits and Risk Controls" + path: docs/pages/prediction/limits-risk.mdx + icon: fa-duotone fa-shield-exclamation + - page: "Prediction Frequently Asked Questions" + path: docs/pages/prediction/faq.mdx + icon: fa-duotone fa-message-question - tab: developers layout: - section: Overview @@ -664,55 +733,83 @@ navigation: - page: Integration Recommendations path: docs/pages/developer-api/integration-recommendations.mdx icon: fa-duotone fa-lightbulb - - tab: integration + - tab: aiHub layout: - section: Overview contents: - - page: Integration Overview - path: docs/pages/developer-api/integration-overview.mdx - icon: fa-duotone fa-diagram-project - - page: Environments and Common Conventions - path: docs/pages/developer-api/environments-and-common-conventions.mdx - icon: fa-duotone fa-server - - section: Authentication & Signing - contents: - - page: Authentication - path: docs/pages/developer-api/authentication.mdx - icon: fa-duotone fa-user-shield - - page: API Key Management - path: docs/pages/developer-api/api-key-management.mdx - icon: fa-duotone fa-key - - page: Request Signing - path: docs/pages/developer-api/request-signing.mdx - icon: fa-duotone fa-signature - - section: Build an Integration - contents: - - page: Trading Widget Quick Start - path: docs/pages/sdk/trading-widget/quick-start.mdx - icon: fa-duotone fa-window - - page: Agent SDK Overview - path: docs/pages/sdk/agent-sdk/overview.mdx + - page: AI Hub Overview + path: docs/pages/ai-hub/overview.mdx + icon: fa-duotone fa-sparkles + - page: Choose a Setup + path: docs/pages/ai-hub/choose-a-setup.mdx + icon: fa-duotone fa-route + - section: Access Methods + contents: + - page: Hosted MCP + path: docs/pages/ai-hub/hosted-mcp.mdx + icon: fa-duotone fa-cloud + - page: Local MCP + path: docs/pages/ai-hub/local-mcp.mdx + icon: fa-duotone fa-computer + - page: 6MM CLI + path: docs/pages/ai-hub/cli.mdx + icon: fa-duotone fa-terminal + - page: Remote MCP Deployment + path: docs/pages/ai-hub/remote-mcp.mdx icon: fa-duotone fa-server - - page: Java Quick Start - path: docs/pages/sdk/agent-sdk/java/quick-start.mdx - icon: fa-brands fa-java - - page: PHP Quick Start - path: docs/pages/sdk/agent-sdk/php/quick-start.mdx - icon: fa-brands fa-php - - section: Production Readiness - contents: - - page: Secrets & Signing - path: docs/pages/sdk/security/secrets-signing.mdx + - section: MCP Reference + contents: + - page: MCP Tools + path: docs/pages/ai-hub/mcp-reference/tools.mdx + icon: fa-duotone fa-screwdriver-wrench + - page: MCP Resources + path: docs/pages/ai-hub/mcp-reference/resources.mdx + icon: fa-duotone fa-book-open + - page: MCP Prompts + path: docs/pages/ai-hub/mcp-reference/prompts.mdx + icon: fa-duotone fa-messages + - section: Workflows & Clients + contents: + - page: Agentic Skills + path: docs/pages/ai-hub/agentic-skills.mdx + icon: fa-duotone fa-layer-group + - page: Client Guides + path: docs/pages/ai-hub/client-guides.mdx + icon: fa-duotone fa-laptop-code + - section: AI Clients + contents: + - page: ChatGPT Desktop + path: docs/pages/ai-hub/clients/chatgpt-desktop.mdx + icon: fa-duotone fa-message-bot + - page: Claude Desktop + path: docs/pages/ai-hub/clients/claude-desktop.mdx + icon: fa-duotone fa-comments + - page: Claude Code CLI + path: docs/pages/ai-hub/clients/claude-code-cli.mdx + icon: fa-duotone fa-terminal + - page: Codex CLI + path: docs/pages/ai-hub/clients/codex-cli.mdx + icon: fa-duotone fa-code + - page: Cursor + path: docs/pages/ai-hub/clients/cursor.mdx + icon: fa-duotone fa-arrow-pointer + - page: Gemini CLI + path: docs/pages/ai-hub/clients/gemini-cli.mdx + icon: fa-duotone fa-sparkles + - page: VS Code / GitHub Copilot + path: docs/pages/ai-hub/clients/vscode-copilot.mdx + icon: fa-duotone fa-laptop-code + - page: Windsurf + path: docs/pages/ai-hub/clients/windsurf.mdx + icon: fa-duotone fa-wind + - section: Security & Roadmap + contents: + - page: Security Model + path: docs/pages/ai-hub/security-model.mdx icon: fa-duotone fa-shield-keyhole - - page: Webhooks & Idempotency - path: docs/pages/sdk/security/webhooks-idempotency.mdx - icon: fa-duotone fa-webhook - - page: Production Launch Checklist - path: docs/pages/resources/production-launch-checklist.mdx - icon: fa-duotone fa-clipboard-check - - page: Support Request Template - path: docs/pages/resources/support-request-template.mdx - icon: fa-duotone fa-life-ring + - page: AI Hub Roadmap + path: docs/pages/ai-hub/roadmap.mdx + icon: fa-duotone fa-timeline - tab: sdk layout: - section: Overview diff --git a/fern/docs/pages/ai-hub/agentic-skills.mdx b/fern/docs/pages/ai-hub/agentic-skills.mdx new file mode 100644 index 00000000..904ab33c --- /dev/null +++ b/fern/docs/pages/ai-hub/agentic-skills.mdx @@ -0,0 +1,40 @@ +--- +title: "Agentic Skills" +subtitle: "Use structured AI workflow templates for analysis, risk management, and execution planning." +slug: ai-hub/agentic-skills +--- + +> **Planned — not yet launched** +> AI Hub is a planned feature. Capabilities, endpoints, commands and client configurations on this page describe the proposed design and are not currently available. Final availability and setup instructions will be announced at launch. + + +Agentic Skills are higher-level workflow templates built on top of CLI and MCP tools. + +They define when an agent should use tools, what actions are forbidden, what output format to produce, and which risk checks are required. + +
6MM Docs
Official documentation for partners, trading platforms, and developers. Learn embedded trading, white-label exchange, institutional liquidity, API / SDK integration, and the security and compliance work needed before production launch.
+Official documentation for partners, trading platforms, and developers. Product documentation covers futures and prediction trading.
6MM Docs
الوثائق الرسمية للشركاء، ومنصات التداول، والمطورين. تعلم التداول المدمج، وبورصة العلامة البيضاء، والسيولة المؤسسية، وتكامل API / SDK ، وأعمال الأمان والامتثال اللازمة قبل بدء الإنتاج.
+الوثائق الرسمية للشركاء، ومنصات التداول، والمطورين. تغطي وثائق المنتجات تداول العقود الآجلة وتداول التنبؤات.
6MM Docs
Offizielle Dokumentation für Partner, Handelsplattformen und Entwickler. Lerne Embedded Trading, White-Label-Börsen, institutionelle Liquidität, API / SDK -Integration sowie die Sicherheits- und Compliance-Arbeit vor dem Produktionsstart kennen.
+Offizielle Dokumentation für Partner, Handelsplattformen und Entwickler. Die Produktdokumentation behandelt Futures-Handel und Prognosehandel.
6MM Docs
Επίσημη τεκμηρίωση για συνεργάτες, πλατφόρμες συναλλαγών και προγραμματιστές. Μάθετε τις ενσωματωμένες συναλλαγές, την ανταλλαγή λευκής ετικέτας, τη θεσμική ρευστότητα, την ενοποίηση API / SDK και τις εργασίες ασφάλειας και συμμόρφωσης που απαιτούνται πριν από την έναρξη της παραγωγής.
+Επίσημη τεκμηρίωση για συνεργάτες, πλατφόρμες συναλλαγών και προγραμματιστές. Η τεκμηρίωση προϊόντων καλύπτει τις συναλλαγές συμβολαίων μελλοντικής εκπλήρωσης και τις συναλλαγές προβλέψεων.
6MM Docs
Documentación oficial para socios, plataformas de trading y desarrolladores. Aprende trading embebido, intercambio white label, liquidez institucional, integración API / SDK y el trabajo de seguridad y cumplimiento necesario antes del lanzamiento en producción.
+Documentación oficial para socios, plataformas de trading y desarrolladores. La documentación de productos abarca el trading de futuros y de predicciones.
6MM Docs
Documentación oficial para socios, plataformas de trading y desarrolladores. Aprende trading embebido, exchange white label, liquidez institucional, integración API / SDK y el trabajo de seguridad y cumplimiento necesarios antes del lanzamiento en producción.
+Documentación oficial para socios, plataformas de trading y desarrolladores. La documentación de productos abarca el trading de futuros y de predicciones.
6MM Docs
Documentation officielle pour les partenaires, plateformes de trading et développeurs. Apprenez le trading embarqué, le marché en marque blanche, la liquidité institutionnelle, l’intégration API / SDK , ainsi que le travail de sécurité et de conformité nécessaire avant le lancement en production.
+Documentation officielle pour les partenaires, plateformes de trading et développeurs. La documentation produit couvre le trading de contrats à terme et le trading de prédictions.
6MM Docs
Dokumentasi resmi untuk mitra, platform trading, dan pengembang. Pelajari embedded trading, white-label exchange, likuiditas institusional, integrasi API / SDK , serta pekerjaan keamanan dan kepatuhan yang diperlukan sebelum peluncuran produksi.
+Dokumentasi resmi untuk mitra, platform trading, dan pengembang. Dokumentasi produk mencakup perdagangan berjangka dan perdagangan prediksi.
6MM Docs
Documentazione ufficiale per partner, piattaforme di trading e sviluppatori. Impara trading embedded, exchange white-label, liquidità istituzionale, integrazione API / SDK e il lavoro di sicurezza e conformità necessario prima del lancio in produzione.
+Documentazione ufficiale per partner, piattaforme di trading e sviluppatori. La documentazione dei prodotti copre il trading di futures e di previsioni.
6MM Docs
パートナー、取引プラットフォーム、開発者向けの公式ドキュメント。組み込み取引、ホワイトラベル取引所、機関投資家向け流動性、 API / SDK 統合、そして本番環境開始前のセキュリティおよびコンプライアンス作業を学びましょう。
+パートナー、取引プラットフォーム、開発者向けの公式ドキュメント。製品ドキュメントでは、先物取引と予測取引を扱います。
6MM Docs
파트너, 거래 플랫폼, 개발자를 위한 공식 문서입니다. 임베디드 트레이딩, 화이트라벨 거래소, 기관 유동성, API / SDK 통합, 그리고 생산 출시 전 필요한 보안 및 컴플라이언스 업무를 배워보세요.
+파트너, 거래 플랫폼, 개발자를 위한 공식 문서입니다. 제품 문서는 선물 거래와 예측 거래를 다룹니다.
6MM Docs
Oficjalna dokumentacja dla partnerów, platform handlowych i deweloperów. Poznaj handel wbudowany, giełdę white-label, płynność instytucjonalną, integrację API / SDK oraz pracę nad bezpieczeństwem i zgodnością przed uruchomieniem produkcji.
+Oficjalna dokumentacja dla partnerów, platform handlowych i deweloperów. Dokumentacja produktów obejmuje handel kontraktami terminowymi i handel oparty na prognozach.
6MM Docs
Documentação oficial para parceiros, plataformas de negociação e desenvolvedores. Aprenda trading embarcado, exchange white-label, liquidez institucional, integração API / SDK e o trabalho de segurança e conformidade necessários antes do lançamento em produção.
+Documentação oficial para parceiros, plataformas de negociação e desenvolvedores. A documentação dos produtos abrange a negociação de futuros e de previsões.
6MM Docs
Documentação oficial para parceiros, plataformas de negociação e programadores. Aprenda trading embutido, exchange white-label, liquidez institucional, integração API / SDK e o trabalho de segurança e conformidade necessário antes do lançamento em produção.
+Documentação oficial para parceiros, plataformas de negociação e programadores. A documentação dos produtos abrange a negociação de futuros e de previsões.
6MM Docs
Официальная документация для партнеров, торговых платформ и разработчиков. Изучите встроенную торговлю, white-label exchange, институциональную ликвидность, интеграцию API / SDK , а также работу по безопасности и комплаенсу, необходимые перед запуском продакшена.
+Официальная документация для партнеров, торговых платформ и разработчиков. Документация по продуктам охватывает торговлю фьючерсами и торговлю прогнозами.
6MM Docs
Ortaklar, ticaret platformları ve geliştiriciler için resmi dokümantasyon. Gömülü ticaret, beyaz etiketli değişim, kurumsal likidite, API / SDK entegrasyonu ve üretim başlatmadan önce gereken güvenlik ve uyum işlerini öğrenin.
+Ortaklar, ticaret platformları ve geliştiriciler için resmi dokümantasyon. Ürün belgeleri vadeli işlemleri ve tahmin işlemlerini kapsar.
6MM Docs
Офіційна документація для партнерів, торгових платформ і розробників. Вивчіть вбудовану торгівлю, white-label exchange, інституційну ліквідність, інтеграцію API / SDK , а також роботу з безпеки та відповідності перед запуском продакшену.
+Офіційна документація для партнерів, торгових платформ і розробників. Документація продуктів охоплює торгівлю ф’ючерсами та прогнозами.
6MM Docs
Tài liệu chính thức dành cho đối tác, nền tảng giao dịch và nhà phát triển. Tìm hiểu về giao dịch nhúng, sàn giao dịch nhãn trắng, thanh khoản tổ chức, tích hợp API / SDK , cũng như các công việc bảo mật và tuân thủ cần thiết trước khi ra mắt sản xuất.
+Tài liệu chính thức dành cho đối tác, nền tảng giao dịch và nhà phát triển. Tài liệu sản phẩm bao gồm giao dịch hợp đồng tương lai và giao dịch dự đoán.
6MM Docs
面向合作方、交易平台和开发者的官方文档。了解嵌入式交易、白标交易所、机构级流动性、API / SDK 接入,以及生产上线前的安全与合规准备。
+面向合作方、交易平台和开发者的官方文档。产品文档涵盖合约交易与预测交易。
6MM Docs
合作夥伴、交易平台及開發者官方文件。學習嵌入式交易、白標交易所、機構級流動性、API / SDK 整合,以及正式上線前所需的安全與合規工作。
+合作夥伴、交易平台及開發者官方文件。產品文件涵蓋合約交易與預測交易。