# QuantDinger Official Website

Static product website and developer documentation for [QuantDinger](https://quantdinger.com), the self-hosted AI Trading OS.

- Website: <https://quantdinger.com>
- App: <https://ai.quantdinger.com>
- Repository: <https://github.com/brokermr810/QuantDinger>
- MCP package: <https://pypi.org/project/quantdinger-mcp/> (`0.4.0`)

## Current release

The website is synchronized with QuantDinger `v5.0.1` and documents:

- separate API, trading, scheduler, Celery worker, Celery beat and migration roles;
- PostgreSQL-backed commands, leases, heartbeats and fencing tokens;
- separate cache Redis and durable Celery job Redis services;
- Strategy API V2 as the only current executable strategy contract;
- human and Agent API boundaries;
- optional Prometheus, Grafana and Alertmanager observability;
- `quantdinger-mcp` `0.4.0` with 25 curated tools and R/W/B/T scopes.

The English and Simplified Chinese pages contain native v5 copy. Architecture-sensitive strings in other landing-page locales use the canonical English v5 copy until those translations are refreshed, preventing stale v4 behavior from being presented as current.

## Stack

- Pure HTML, CSS and vanilla JavaScript; no build step.
- Inter and JetBrains Mono via Google Fonts.
- Responsive landing page with ten selectable locales.
- Generated multi-page documentation center with full-text search and mobile navigation.
- All maintained Markdown, OpenAPI, examples, architecture diagrams and screenshots from the backend repository.

## Structure

```text
quantdinger_html/
|-- index.html          Product website and SEO metadata
|-- doc/                Generated complete documentation center
|-- docs.html           Compatibility redirect to doc/README.html
|-- docs-zh.html        Compatibility redirect to doc/README_CN.html
|-- css/styles.css      Landing-page design system
|-- js/main.js          Landing interactions and i18n dictionaries
|-- js/site-config.js   Commercial-license form configuration
|-- scripts/build_docs.py   Documentation generator
|-- scripts/docs_assets/    Documentation UI source assets
|-- requirements-docs.txt   Pinned documentation build dependency
|-- assets/logo.jpg     Brand mark, favicon and social image
|-- robots.txt          Crawl policy
`-- sitemap.xml         Public URLs and page anchors
```

## Documentation maintenance

The backend repository's `docs/` directory is the engineering source of truth. The public `/doc/` center is generated from every file under that directory; do not hand-edit generated files.

Rebuild after changing the backend documentation:

```bash
python -m pip install -r requirements-docs.txt
python scripts/build_docs.py
python scripts/check_docs.py
```

The generator currently publishes all maintained material, including:

- architecture, module boundaries, process roles, concurrency and extension rules;
- cloud deployment, production hardening, observability and installation troubleshooting;
- multi-user, OAuth, payment and Email/SMS/Telegram configuration;
- Strategy API V2, indicator development, public universes and IBKR trading;
- Human OpenAPI, Agent OpenAPI, MCP setup and Agent integration design;
- runnable Python examples, diagrams, screenshots and original Markdown sources.

`docs.html` and `docs-zh.html` are compatibility redirects only. Do not restore the retired IndicatorStrategy/ScriptStrategy documentation: v5 executable strategies use Strategy API V2, while indicators are chart-only artifacts.

## Commercial-license form

Set the Formspree form ID in `js/site-config.js`:

```javascript
window.QD_SITE_CONFIG = {
  formspreeLicenseFormId: 'your_form_id_here'
};
```

## Local preview

```bash
python -m http.server 8080
```

Open <http://localhost:8080>. The site may also be served by any static host, including GitHub Pages, Cloudflare Pages, Netlify or Nginx.

## Legal

QuantDinger has not issued, does not endorse and will not launch any token, coin, ICO, airdrop or cryptocurrency. Trading involves risk; the software and AI output are not financial advice.

Copyright OpenByte Inc. All rights reserved.