mirror of
https://github.com/koala73/worldmonitor.git
synced 2026-04-25 17:14:57 +02:00
feat(docs): add Mintlify documentation site at /docs (#1444)
Set up Mintlify to serve docs at worldmonitor.app/docs via Vercel rewrites proxying to worldmonitor.mintlify.dev. - Add mint.json with navigation (5 doc groups + 22 OpenAPI API references) - Add Vercel rewrites for /docs, exclude from SPA catch-all and no-cache rules - Exclude /docs from CSP headers (Mintlify manages its own scripts/styles) - Add frontmatter to all 18 navigation docs for proper Mintlify rendering - Fix internal links from ./FILE.md to /FILE format for Mintlify routing - Convert ../path links to GitHub URLs (source code references) - Add .mintlifyignore for internal docs (Docs_To_Review, roadmap, etc.) - Copy app icon as logo.png and favicon.png
This commit is contained in:
Elie Habib
9
docs/.mintlifyignore
Normal file
9
docs/.mintlifyignore
Normal file
@@ -0,0 +1,9 @@
|
||||
Docs_To_Review/
|
||||
internal/
|
||||
images/
|
||||
roadmap-pro.md
|
||||
user-requests.md
|
||||
local-backend-audit.md
|
||||
PRESS_KIT.md
|
||||
COMMUNITY-PROMOTION-GUIDE.md
|
||||
TAURI_VALIDATION_REPORT.md
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: "Adding API Endpoints"
|
||||
description: "All JSON API endpoints in WorldMonitor must use sebuf. This guide walks through adding a new RPC to an existing service and adding an entirely new service."
|
||||
---
|
||||
|
||||
# Adding API Endpoints
|
||||
|
||||
All JSON API endpoints in WorldMonitor **must** use sebuf. Do not create standalone `api/*.js` files — the legacy pattern is deprecated and being removed.
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: "AI Intelligence"
|
||||
description: "LLM chains, RAG pipelines, threat classification, deduction engines, and browser-side ML used in World Monitor."
|
||||
---
|
||||
|
||||
# AI Intelligence
|
||||
|
||||
LLM chains, RAG pipelines, threat classification, deduction engines, and browser-side ML used in World Monitor.
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: "Algorithms & Scoring"
|
||||
description: "Detailed documentation of World Monitor's scoring formulas, detection algorithms, and classification pipelines."
|
||||
---
|
||||
|
||||
# Algorithms & Scoring
|
||||
|
||||
Detailed documentation of World Monitor's scoring formulas, detection algorithms, and classification pipelines.
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: "API Key Gating & Registration — Deployment Guide"
|
||||
description: "Desktop cloud fallback is gated on a WORLDMONITOR_API_KEY. Without a valid key, the desktop app operates local-only (sidecar). A registration form collects emails via Convex DB for future key distribution."
|
||||
---
|
||||
|
||||
# API Key Gating & Registration — Deployment Guide
|
||||
|
||||
## Overview
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: "Architecture"
|
||||
description: "System design, caching strategies, bootstrap hydration, edge functions, and implementation patterns used in World Monitor."
|
||||
---
|
||||
|
||||
# Architecture
|
||||
|
||||
System design, caching strategies, bootstrap hydration, edge functions, and implementation patterns used in World Monitor.
|
||||
@@ -122,7 +127,7 @@ This pattern is enforced project-wide across all panel subclasses. In E2E tests,
|
||||
|
||||
## API & Data Pipeline
|
||||
|
||||
> **CORS** — all API endpoints enforce an origin allowlist. See [CORS.md](./CORS.md) for the allowed origins, implementation details, and how to add CORS to new endpoints.
|
||||
> **CORS** — all API endpoints enforce an origin allowlist. See [CORS.md](/CORS) for the allowed origins, implementation details, and how to add CORS to new endpoints.
|
||||
|
||||
### Proto-First API Contracts
|
||||
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: "CORS"
|
||||
description: "How cross-origin request protection works and what to do when adding new API endpoints."
|
||||
---
|
||||
|
||||
# CORS
|
||||
|
||||
How cross-origin request protection works and what to do when adding new API endpoints.
|
||||
@@ -73,7 +78,7 @@ To allow a new origin:
|
||||
|
||||
1. Add a regex pattern to `ALLOWED_ORIGIN_PATTERNS` in **both** `api/_cors.js` and `server/cors.ts`.
|
||||
2. Update the test in `api/_cors.test.mjs`.
|
||||
3. If the origin is a new production subdomain, also add it to the Cloudflare R2 CORS rules (see [MEMORY.md notes on R2 CORS](../MEMORY.md)).
|
||||
3. If the origin is a new production subdomain, also add it to the Cloudflare R2 CORS rules (see MEMORY.md notes on R2 CORS in the repo root).
|
||||
|
||||
## Allowed Headers
|
||||
|
||||
@@ -87,4 +92,4 @@ To allow additional headers, update `Access-Control-Allow-Headers` in both files
|
||||
|
||||
## Railway Relay CORS
|
||||
|
||||
The Railway relay (`scripts/ais-relay.cjs`) has its own CORS handling with the `ALLOW_VERCEL_PREVIEW_ORIGINS` env var. See [RELAY_PARAMETERS.md](./RELAY_PARAMETERS.md) for details.
|
||||
The Railway relay (`scripts/ais-relay.cjs`) has its own CORS handling with the `ALLOW_VERCEL_PREVIEW_ORIGINS` env var. See [RELAY_PARAMETERS.md](/RELAY_PARAMETERS) for details.
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: "Data Sources"
|
||||
description: "Comprehensive documentation of all data sources, feed tiers, and collection methods used by World Monitor."
|
||||
---
|
||||
|
||||
# Data Sources
|
||||
|
||||
Comprehensive documentation of all data sources, feed tiers, and collection methods used by World Monitor.
|
||||
@@ -33,7 +38,7 @@ Comprehensive documentation of all data sources, feed tiers, and collection meth
|
||||
- Nuclear facilities & gamma irradiators
|
||||
- APT cyber threat actor attribution
|
||||
- Spaceports & launch facilities
|
||||
- **Orbital surveillance** — ~80–120 intelligence-relevant satellites tracked in real time via CelesTrak TLE data and client-side SGP4 propagation (satellite.js). Country-coded markers at orbital altitude, 15-min orbit trails, ground footprints. Globe-only. [Details →](./ORBITAL_SURVEILLANCE.md)
|
||||
- **Orbital surveillance** — ~80–120 intelligence-relevant satellites tracked in real time via CelesTrak TLE data and client-side SGP4 propagation (satellite.js). Country-coded markers at orbital altitude, 15-min orbit trails, ground footprints. Globe-only. [Details →](/ORBITAL_SURVEILLANCE)
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: "Desktop Application"
|
||||
description: "Tauri desktop architecture, sidecar management, secret storage, cloud fallback, and multi-platform build details."
|
||||
---
|
||||
|
||||
# Desktop Application
|
||||
|
||||
Tauri desktop architecture, sidecar management, secret storage, cloud fallback, and multi-platform build details.
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: "World Monitor — Full Documentation"
|
||||
description: "AI-powered real-time global intelligence dashboard aggregating news, markets, geopolitical data, and infrastructure monitoring into a unified situation awareness interface."
|
||||
---
|
||||
|
||||
# World Monitor — Full Documentation
|
||||
|
||||
AI-powered real-time global intelligence dashboard aggregating news, markets, geopolitical data, and infrastructure monitoring into a unified situation awareness interface.
|
||||
@@ -8,21 +13,21 @@ AI-powered real-time global intelligence dashboard aggregating news, markets, ge
|
||||
|
||||
| Document | Description |
|
||||
|---|---|
|
||||
| [README](../README.md) | Project overview, quick start, and self-hosting guide |
|
||||
| [Algorithms](./ALGORITHMS.md) | Scoring formulas, detection algorithms, classification pipelines |
|
||||
| [Data Sources](./DATA_SOURCES.md) | All 31+ data sources, feed tiers, and collection methods |
|
||||
| [Architecture](./ARCHITECTURE.md) | System design, caching, bootstrap hydration, edge functions |
|
||||
| [Map Engine](./MAP_ENGINE.md) | 3D globe and flat map rendering details |
|
||||
| [AI Intelligence](./AI_INTELLIGENCE.md) | LLM chains, RAG, threat classification, deduction |
|
||||
| [Desktop App](./DESKTOP_APP.md) | Tauri architecture, sidecar, secret management |
|
||||
| [Finance Data](./FINANCE_DATA.md) | Market radar, Gulf FDI, stablecoins, BIS, WTO |
|
||||
| [Premium Finance](./PREMIUM_FINANCE.md) | Premium stock analysis, stored history, backtests, daily brief |
|
||||
| [Premium Finance Search Layer](./PREMIUM_FINANCE_SEARCH.md) | Targeted stock-news provider chain layered on top of premium finance |
|
||||
| [Orbital Surveillance](./ORBITAL_SURVEILLANCE.md) | Satellite tracking, SGP4 propagation, tier availability, roadmap |
|
||||
| [README](https://github.com/koala73/worldmonitor#readme) | Project overview, quick start, and self-hosting guide |
|
||||
| [Algorithms](/ALGORITHMS) | Scoring formulas, detection algorithms, classification pipelines |
|
||||
| [Data Sources](/DATA_SOURCES) | All 31+ data sources, feed tiers, and collection methods |
|
||||
| [Architecture](/ARCHITECTURE) | System design, caching, bootstrap hydration, edge functions |
|
||||
| [Map Engine](/MAP_ENGINE) | 3D globe and flat map rendering details |
|
||||
| [AI Intelligence](/AI_INTELLIGENCE) | LLM chains, RAG, threat classification, deduction |
|
||||
| [Desktop App](/DESKTOP_APP) | Tauri architecture, sidecar, secret management |
|
||||
| [Finance Data](/FINANCE_DATA) | Market radar, Gulf FDI, stablecoins, BIS, WTO |
|
||||
| [Premium Finance](/PREMIUM_FINANCE) | Premium stock analysis, stored history, backtests, daily brief |
|
||||
| [Premium Finance Search Layer](/PREMIUM_FINANCE_SEARCH) | Targeted stock-news provider chain layered on top of premium finance |
|
||||
| [Orbital Surveillance](/ORBITAL_SURVEILLANCE) | Satellite tracking, SGP4 propagation, tier availability, roadmap |
|
||||
| [API Reference](./api/) | OpenAPI specs for all 22 services |
|
||||
| [Health Endpoints](./HEALTH_ENDPOINTS.md) | `/api/health` and `/api/seed-health` reference, staleness thresholds, monitoring integration |
|
||||
| [Adding Endpoints](./ADDING_ENDPOINTS.md) | Guide for adding new RPC endpoints |
|
||||
| [Release Packaging](./RELEASE_PACKAGING.md) | Desktop build and release process |
|
||||
| [Health Endpoints](/HEALTH_ENDPOINTS) | `/api/health` and `/api/seed-health` reference, staleness thresholds, monitoring integration |
|
||||
| [Adding Endpoints](/ADDING_ENDPOINTS) | Guide for adding new RPC endpoints |
|
||||
| [Release Packaging](/RELEASE_PACKAGING) | Desktop build and release process |
|
||||
|
||||
---
|
||||
|
||||
@@ -3699,7 +3704,7 @@ The system degrades gracefully—blocked sources are skipped while others contin
|
||||
|
||||
## Roadmap
|
||||
|
||||
See [ROADMAP.md](../.planning/ROADMAP.md) for detailed planning. Recent intelligence enhancements:
|
||||
See [ROADMAP.md](https://github.com/koala73/worldmonitor/blob/main/.planning/ROADMAP.md) for detailed planning. Recent intelligence enhancements:
|
||||
|
||||
### Completed
|
||||
|
||||
@@ -3755,7 +3760,7 @@ See [ROADMAP.md](../.planning/ROADMAP.md) for detailed planning. Recent intellig
|
||||
- **Additional Data Sources** - World Bank, IMF, OFAC sanctions, UNHCR refugee data, FAO food security
|
||||
- **Think Tank Feeds** - RUSI, Chatham House, ECFR, CFR, Wilson Center, CNAS, Arms Control Association
|
||||
|
||||
The full [ROADMAP.md](../.planning/ROADMAP.md) documents implementation details, API endpoints, and 30+ free data sources for future integration.
|
||||
The full [ROADMAP.md](https://github.com/koala73/worldmonitor/blob/main/.planning/ROADMAP.md) documents implementation details, API endpoints, and 30+ free data sources for future integration.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,11 +1,16 @@
|
||||
---
|
||||
title: "Finance & Market Data"
|
||||
description: "Market radar, Gulf FDI tracking, stablecoin monitoring, energy analytics, and trade policy intelligence in World Monitor."
|
||||
---
|
||||
|
||||
# Finance & Market Data
|
||||
|
||||
Market radar, Gulf FDI tracking, stablecoin monitoring, energy analytics, and trade policy intelligence in World Monitor.
|
||||
|
||||
For the premium stock-analysis product layer, see:
|
||||
|
||||
- [Premium Finance](./PREMIUM_FINANCE.md)
|
||||
- [Premium Finance Search Layer](./PREMIUM_FINANCE_SEARCH.md)
|
||||
- [Premium Finance](/PREMIUM_FINANCE)
|
||||
- [Premium Finance Search Layer](/PREMIUM_FINANCE_SEARCH)
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: "Health Endpoints"
|
||||
description: "World Monitor exposes two health endpoints for monitoring data pipeline integrity. Both run on the Vercel Edge Runtime and query Redis (Upstash) to assess system state."
|
||||
---
|
||||
|
||||
# Health Endpoints
|
||||
|
||||
World Monitor exposes two health endpoints for monitoring data pipeline integrity. Both run on the Vercel Edge Runtime and query Redis (Upstash) to assess system state.
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: "Maps Infrastructure & Geocoding"
|
||||
description: "Static map assets, country geometry, geocoding services, and boundary overrides."
|
||||
---
|
||||
|
||||
# Maps Infrastructure & Geocoding
|
||||
|
||||
Static map assets, country geometry, geocoding services, and boundary overrides.
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: "Map Engine"
|
||||
description: "3D globe and flat map rendering, textures, shaders, clustering, and mobile touch gestures in World Monitor."
|
||||
---
|
||||
|
||||
# Map Engine
|
||||
|
||||
3D globe and flat map rendering, textures, shaders, clustering, and mobile touch gestures in World Monitor.
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: "Orbital Surveillance"
|
||||
description: "Real-time satellite orbital tracking on the 3D globe, powered by SGP4 propagation from CelesTrak TLE data."
|
||||
---
|
||||
|
||||
# Orbital Surveillance
|
||||
|
||||
Real-time satellite orbital tracking on the 3D globe, powered by SGP4 propagation from CelesTrak TLE data.
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: "Premium Finance"
|
||||
description: "Premium finance is the finance-variant layer that ports the reusable stock-analysis product surface from daily_stock_analysis into World Monitor without importing that repo's full standalone app architecture."
|
||||
---
|
||||
|
||||
# Premium Finance
|
||||
|
||||
Premium finance is the finance-variant layer that ports the reusable stock-analysis product surface from `../daily_stock_analysis` into World Monitor without importing that repo's full standalone app architecture.
|
||||
@@ -48,35 +53,35 @@ It does **not** attempt full parity with the source repo's:
|
||||
|
||||
Primary handlers:
|
||||
|
||||
- [analyze-stock.ts](../server/worldmonitor/market/v1/analyze-stock.ts)
|
||||
- [get-stock-analysis-history.ts](../server/worldmonitor/market/v1/get-stock-analysis-history.ts)
|
||||
- [backtest-stock.ts](../server/worldmonitor/market/v1/backtest-stock.ts)
|
||||
- [list-stored-stock-backtests.ts](../server/worldmonitor/market/v1/list-stored-stock-backtests.ts)
|
||||
- [premium-stock-store.ts](../server/worldmonitor/market/v1/premium-stock-store.ts)
|
||||
- [analyze-stock.ts](https://github.com/koala73/worldmonitor/blob/main/server/worldmonitor/market/v1/analyze-stock.ts)
|
||||
- [get-stock-analysis-history.ts](https://github.com/koala73/worldmonitor/blob/main/server/worldmonitor/market/v1/get-stock-analysis-history.ts)
|
||||
- [backtest-stock.ts](https://github.com/koala73/worldmonitor/blob/main/server/worldmonitor/market/v1/backtest-stock.ts)
|
||||
- [list-stored-stock-backtests.ts](https://github.com/koala73/worldmonitor/blob/main/server/worldmonitor/market/v1/list-stored-stock-backtests.ts)
|
||||
- [premium-stock-store.ts](https://github.com/koala73/worldmonitor/blob/main/server/worldmonitor/market/v1/premium-stock-store.ts)
|
||||
|
||||
Primary contracts:
|
||||
|
||||
- [analyze_stock.proto](../proto/worldmonitor/market/v1/analyze_stock.proto)
|
||||
- [get_stock_analysis_history.proto](../proto/worldmonitor/market/v1/get_stock_analysis_history.proto)
|
||||
- [backtest_stock.proto](../proto/worldmonitor/market/v1/backtest_stock.proto)
|
||||
- [list_stored_stock_backtests.proto](../proto/worldmonitor/market/v1/list_stored_stock_backtests.proto)
|
||||
- [service.proto](../proto/worldmonitor/market/v1/service.proto)
|
||||
- [analyze_stock.proto](https://github.com/koala73/worldmonitor/blob/main/proto/worldmonitor/market/v1/analyze_stock.proto)
|
||||
- [get_stock_analysis_history.proto](https://github.com/koala73/worldmonitor/blob/main/proto/worldmonitor/market/v1/get_stock_analysis_history.proto)
|
||||
- [backtest_stock.proto](https://github.com/koala73/worldmonitor/blob/main/proto/worldmonitor/market/v1/backtest_stock.proto)
|
||||
- [list_stored_stock_backtests.proto](https://github.com/koala73/worldmonitor/blob/main/proto/worldmonitor/market/v1/list_stored_stock_backtests.proto)
|
||||
- [service.proto](https://github.com/koala73/worldmonitor/blob/main/proto/worldmonitor/market/v1/service.proto)
|
||||
|
||||
### Frontend Surfaces
|
||||
|
||||
Panels:
|
||||
|
||||
- [StockAnalysisPanel.ts](../src/components/StockAnalysisPanel.ts)
|
||||
- [StockBacktestPanel.ts](../src/components/StockBacktestPanel.ts)
|
||||
- [DailyMarketBriefPanel.ts](../src/components/DailyMarketBriefPanel.ts)
|
||||
- [StockAnalysisPanel.ts](https://github.com/koala73/worldmonitor/blob/main/src/components/StockAnalysisPanel.ts)
|
||||
- [StockBacktestPanel.ts](https://github.com/koala73/worldmonitor/blob/main/src/components/StockBacktestPanel.ts)
|
||||
- [DailyMarketBriefPanel.ts](https://github.com/koala73/worldmonitor/blob/main/src/components/DailyMarketBriefPanel.ts)
|
||||
|
||||
Services and loading:
|
||||
|
||||
- [stock-analysis.ts](../src/services/stock-analysis.ts)
|
||||
- [stock-analysis-history.ts](../src/services/stock-analysis-history.ts)
|
||||
- [stock-backtest.ts](../src/services/stock-backtest.ts)
|
||||
- [daily-market-brief.ts](../src/services/daily-market-brief.ts)
|
||||
- [data-loader.ts](../src/app/data-loader.ts)
|
||||
- [stock-analysis.ts](https://github.com/koala73/worldmonitor/blob/main/src/services/stock-analysis.ts)
|
||||
- [stock-analysis-history.ts](https://github.com/koala73/worldmonitor/blob/main/src/services/stock-analysis-history.ts)
|
||||
- [stock-backtest.ts](https://github.com/koala73/worldmonitor/blob/main/src/services/stock-backtest.ts)
|
||||
- [daily-market-brief.ts](https://github.com/koala73/worldmonitor/blob/main/src/services/daily-market-brief.ts)
|
||||
- [data-loader.ts](https://github.com/koala73/worldmonitor/blob/main/src/app/data-loader.ts)
|
||||
|
||||
---
|
||||
|
||||
@@ -176,8 +181,8 @@ Premium finance endpoints are enforced server-side.
|
||||
|
||||
Premium RPC paths are gated in:
|
||||
|
||||
- [gateway.ts](../server/gateway.ts)
|
||||
- [api/_api-key.js](../api/_api-key.js)
|
||||
- [gateway.ts](https://github.com/koala73/worldmonitor/blob/main/server/gateway.ts)
|
||||
- [api/_api-key.js](https://github.com/koala73/worldmonitor/blob/main/api/_api-key.js)
|
||||
|
||||
This matters because a UI-only lock would still allow direct API usage from trusted browser origins.
|
||||
|
||||
@@ -190,9 +195,9 @@ Core premium finance currently depends on:
|
||||
- Yahoo Finance chart/history endpoints
|
||||
- Finnhub for broader market data already used elsewhere in World Monitor
|
||||
- Google News RSS as the baseline stock-news fallback
|
||||
- the shared LLM provider chain in [llm.ts](../server/_shared/llm.ts)
|
||||
- the shared LLM provider chain in [llm.ts](https://github.com/koala73/worldmonitor/blob/main/server/_shared/llm.ts)
|
||||
|
||||
The provider-backed targeted stock-news layer is documented separately in [PREMIUM_FINANCE_SEARCH.md](./PREMIUM_FINANCE_SEARCH.md).
|
||||
The provider-backed targeted stock-news layer is documented separately in [PREMIUM_FINANCE_SEARCH.md](/PREMIUM_FINANCE_SEARCH).
|
||||
|
||||
---
|
||||
|
||||
@@ -225,7 +230,7 @@ The core layer is:
|
||||
|
||||
The search-backed stock-news layer is intentionally separate because it improves analysis quality but is not required for the feature to function. If all search providers are unavailable, premium stock analysis still works using Google News RSS fallback.
|
||||
|
||||
See [PREMIUM_FINANCE_SEARCH.md](./PREMIUM_FINANCE_SEARCH.md).
|
||||
See [PREMIUM_FINANCE_SEARCH.md](/PREMIUM_FINANCE_SEARCH).
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: "Premium Finance Search Layer"
|
||||
description: "This document covers the extra targeted stock-news search layer used by premium finance."
|
||||
---
|
||||
|
||||
# Premium Finance Search Layer
|
||||
|
||||
This document covers the **extra** targeted stock-news search layer used by premium finance.
|
||||
@@ -6,7 +11,7 @@ It is separate from the core premium-finance architecture on purpose.
|
||||
|
||||
Core premium finance can still function without this layer. The search layer exists to improve stock-news discovery quality for targeted ticker analysis, especially where feed-only coverage is weak.
|
||||
|
||||
See the core system document in [PREMIUM_FINANCE.md](./PREMIUM_FINANCE.md).
|
||||
See the core system document in [PREMIUM_FINANCE.md](/PREMIUM_FINANCE).
|
||||
|
||||
---
|
||||
|
||||
@@ -45,11 +50,11 @@ The current provider chain is:
|
||||
|
||||
Primary implementation:
|
||||
|
||||
- [stock-news-search.ts](../server/worldmonitor/market/v1/stock-news-search.ts)
|
||||
- [stock-news-search.ts](https://github.com/koala73/worldmonitor/blob/main/server/worldmonitor/market/v1/stock-news-search.ts)
|
||||
|
||||
Integration point:
|
||||
|
||||
- [analyze-stock.ts](../server/worldmonitor/market/v1/analyze-stock.ts)
|
||||
- [analyze-stock.ts](https://github.com/koala73/worldmonitor/blob/main/server/worldmonitor/market/v1/analyze-stock.ts)
|
||||
|
||||
The helper:
|
||||
|
||||
@@ -96,10 +101,10 @@ Configured keys:
|
||||
|
||||
These are wired through:
|
||||
|
||||
- [runtime-config.ts](../src/services/runtime-config.ts)
|
||||
- [settings-constants.ts](../src/services/settings-constants.ts)
|
||||
- [main.rs](../src-tauri/src/main.rs)
|
||||
- [local-api-server.mjs](../src-tauri/sidecar/local-api-server.mjs)
|
||||
- [runtime-config.ts](https://github.com/koala73/worldmonitor/blob/main/src/services/runtime-config.ts)
|
||||
- [settings-constants.ts](https://github.com/koala73/worldmonitor/blob/main/src/services/settings-constants.ts)
|
||||
- [main.rs](https://github.com/koala73/worldmonitor/blob/main/src-tauri/src/main.rs)
|
||||
- [local-api-server.mjs](https://github.com/koala73/worldmonitor/blob/main/src-tauri/sidecar/local-api-server.mjs)
|
||||
|
||||
The values are multi-key strings, split on commas or newlines.
|
||||
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: "Relay Parameters (Railway + Vercel)"
|
||||
description: "This document covers all environment variables used by the AIS/OpenSky relay path."
|
||||
---
|
||||
|
||||
# Relay Parameters (Railway + Vercel)
|
||||
|
||||
This document covers all environment variables used by the AIS/OpenSky relay path:
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: "Desktop Release Packaging Guide (Local, Reproducible)"
|
||||
description: "This guide provides reproducible local packaging steps for both desktop variants: full (World Monitor) and tech (Tech Monitor)."
|
||||
---
|
||||
|
||||
# Desktop Release Packaging Guide (Local, Reproducible)
|
||||
|
||||
This guide provides reproducible local packaging steps for both desktop variants:
|
||||
|
||||
BIN
docs/favicon.png
Normal file
BIN
docs/favicon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.3 KiB |
BIN
docs/logo.png
Normal file
BIN
docs/logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 58 KiB |
134
docs/mint.json
Normal file
134
docs/mint.json
Normal file
@@ -0,0 +1,134 @@
|
||||
{
|
||||
"$schema": "https://mintlify.com/schema.json",
|
||||
"name": "World Monitor",
|
||||
"logo": {
|
||||
"dark": "/logo.png",
|
||||
"light": "/logo.png"
|
||||
},
|
||||
"favicon": "/favicon.png",
|
||||
"colors": {
|
||||
"primary": "#3b82f6",
|
||||
"light": "#60a5fa",
|
||||
"dark": "#2563eb",
|
||||
"background": {
|
||||
"dark": "#0a0a1a"
|
||||
}
|
||||
},
|
||||
"topbarLinks": [
|
||||
{
|
||||
"name": "Live App",
|
||||
"url": "https://worldmonitor.app"
|
||||
}
|
||||
],
|
||||
"topbarCtaButton": {
|
||||
"name": "GitHub",
|
||||
"url": "https://github.com/koala73/worldmonitor"
|
||||
},
|
||||
"anchors": [
|
||||
{
|
||||
"name": "API Reference",
|
||||
"icon": "code",
|
||||
"url": "api-reference"
|
||||
}
|
||||
],
|
||||
"navigation": [
|
||||
{
|
||||
"group": "Getting Started",
|
||||
"pages": [
|
||||
"DOCUMENTATION",
|
||||
"ARCHITECTURE"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Core Systems",
|
||||
"pages": [
|
||||
"DATA_SOURCES",
|
||||
"ALGORITHMS",
|
||||
"MAP_ENGINE",
|
||||
"AI_INTELLIGENCE",
|
||||
"MAPS_AND_GEOCODING"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Finance",
|
||||
"pages": [
|
||||
"FINANCE_DATA",
|
||||
"PREMIUM_FINANCE",
|
||||
"PREMIUM_FINANCE_SEARCH"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Infrastructure",
|
||||
"pages": [
|
||||
"DESKTOP_APP",
|
||||
"ORBITAL_SURVEILLANCE",
|
||||
"CORS",
|
||||
"HEALTH_ENDPOINTS",
|
||||
"RELAY_PARAMETERS"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Contributing",
|
||||
"pages": [
|
||||
"ADDING_ENDPOINTS",
|
||||
"API_KEY_DEPLOYMENT",
|
||||
"RELEASE_PACKAGING"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "API Reference",
|
||||
"pages": [
|
||||
{
|
||||
"group": "Geopolitical",
|
||||
"openapi": [
|
||||
"api/ConflictService.openapi.yaml",
|
||||
"api/MilitaryService.openapi.yaml",
|
||||
"api/UnrestService.openapi.yaml",
|
||||
"api/IntelligenceService.openapi.yaml",
|
||||
"api/DisplacementService.openapi.yaml",
|
||||
"api/CyberService.openapi.yaml"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Natural Events",
|
||||
"openapi": [
|
||||
"api/NaturalService.openapi.yaml",
|
||||
"api/SeismologyService.openapi.yaml",
|
||||
"api/ClimateService.openapi.yaml",
|
||||
"api/WildfireService.openapi.yaml"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Economy & Markets",
|
||||
"openapi": [
|
||||
"api/EconomicService.openapi.yaml",
|
||||
"api/MarketService.openapi.yaml",
|
||||
"api/TradeService.openapi.yaml",
|
||||
"api/SupplyChainService.openapi.yaml",
|
||||
"api/PredictionService.openapi.yaml"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Infrastructure & Transport",
|
||||
"openapi": [
|
||||
"api/AviationService.openapi.yaml",
|
||||
"api/MaritimeService.openapi.yaml",
|
||||
"api/InfrastructureService.openapi.yaml"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Other",
|
||||
"openapi": [
|
||||
"api/NewsService.openapi.yaml",
|
||||
"api/ResearchService.openapi.yaml",
|
||||
"api/PositiveEventsService.openapi.yaml",
|
||||
"api/GivingService.openapi.yaml"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"footerSocials": {
|
||||
"github": "https://github.com/koala73/worldmonitor"
|
||||
}
|
||||
}
|
||||
16
vercel.json
16
vercel.json
@@ -2,8 +2,10 @@
|
||||
"ignoreCommand": "bash scripts/vercel-ignore.sh",
|
||||
"crons": [],
|
||||
"rewrites": [
|
||||
{ "source": "/docs", "destination": "https://worldmonitor.mintlify.dev/docs" },
|
||||
{ "source": "/docs/:match*", "destination": "https://worldmonitor.mintlify.dev/docs/:match*" },
|
||||
{ "source": "/pro", "destination": "/pro/index.html" },
|
||||
{ "source": "/((?!api|assets|blog|favico|map-styles|data|textures|pro|sw\\.js|manifest\\.webmanifest|offline\\.html|robots\\.txt|sitemap\\.xml|llms\\.txt|llms-full\\.txt|\\.well-known).*)", "destination": "/index.html" }
|
||||
{ "source": "/((?!api|assets|blog|docs|favico|map-styles|data|textures|pro|sw\\.js|manifest\\.webmanifest|offline\\.html|robots\\.txt|sitemap\\.xml|llms\\.txt|llms-full\\.txt|\\.well-known).*)", "destination": "/index.html" }
|
||||
],
|
||||
"headers": [
|
||||
{
|
||||
@@ -15,7 +17,15 @@
|
||||
]
|
||||
},
|
||||
{
|
||||
"source": "/(.*)",
|
||||
"source": "/docs/:path*",
|
||||
"headers": [
|
||||
{ "key": "X-Content-Type-Options", "value": "nosniff" },
|
||||
{ "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains; preload" },
|
||||
{ "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }
|
||||
]
|
||||
},
|
||||
{
|
||||
"source": "/((?!docs).*)",
|
||||
"headers": [
|
||||
{ "key": "X-Content-Type-Options", "value": "nosniff" },
|
||||
{ "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains; preload" },
|
||||
@@ -25,7 +35,7 @@
|
||||
]
|
||||
},
|
||||
{
|
||||
"source": "/((?!api|assets|blog|favico|map-styles|data|textures|pro|sw\\.js|manifest\\.webmanifest|offline\\.html|robots\\.txt|sitemap\\.xml|llms\\.txt|llms-full\\.txt|\\.well-known).*)",
|
||||
"source": "/((?!api|assets|blog|docs|favico|map-styles|data|textures|pro|sw\\.js|manifest\\.webmanifest|offline\\.html|robots\\.txt|sitemap\\.xml|llms\\.txt|llms-full\\.txt|\\.well-known).*)",
|
||||
"headers": [
|
||||
{ "key": "Cache-Control", "value": "no-cache, no-store, must-revalidate" }
|
||||
]
|
||||
|
||||
Reference in New Issue
Block a user