Skip to content

Commit b43d15e

Browse files
committed
docs: launch project site and visual showcase
1 parent e81a79c commit b43d15e

21 files changed

Lines changed: 764 additions & 2 deletions

.github/workflows/pages.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Deploy GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [master]
6+
paths:
7+
- 'site/**'
8+
- 'docs/assets/openalphastack-*.png'
9+
- 'docs/assets/openalphastack-*.gif'
10+
- 'docs/assets/dashboard-search-results.png'
11+
- 'docs/assets/dashboard-workflow.png'
12+
- '.github/workflows/pages.yml'
13+
workflow_dispatch:
14+
15+
permissions:
16+
contents: read
17+
pages: write
18+
id-token: write
19+
20+
concurrency:
21+
group: pages
22+
cancel-in-progress: true
23+
24+
jobs:
25+
deploy:
26+
environment:
27+
name: github-pages
28+
url: ${{ steps.deployment.outputs.page_url }}
29+
runs-on: ubuntu-latest
30+
steps:
31+
- uses: actions/checkout@v4
32+
33+
- name: Assemble static site
34+
run: |
35+
mkdir -p _site/assets
36+
cp -R site/. _site/
37+
cp docs/assets/openalphastack-demo.gif _site/assets/
38+
cp docs/assets/openalphastack-social-preview.png _site/assets/
39+
cp docs/assets/dashboard-search-results.png _site/assets/
40+
cp docs/assets/dashboard-workflow.png _site/assets/
41+
42+
- uses: actions/configure-pages@v5
43+
- uses: actions/upload-pages-artifact@v3
44+
with:
45+
path: _site
46+
- name: Deploy to GitHub Pages
47+
id: deployment
48+
uses: actions/deploy-pages@v4

README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
<h1>OpenAlphaStack</h1>
44

5+
<p>
6+
<a href="README.md">简体中文</a> ·
7+
<a href="README_EN.md">English</a>
8+
</p>
9+
510
<p><strong>面向 A 股研究、回测与模拟交易的开源 Codex 插件栈。</strong></p>
611

712
[![CI](https://github.com/44-99/OpenAlphaStack/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/44-99/OpenAlphaStack/actions/workflows/ci.yml)
@@ -11,10 +16,16 @@
1116
[![MCP](https://img.shields.io/badge/MCP-local--first-1f9d8a.svg)](.mcp.json)
1217
[![GitHub stars](https://img.shields.io/github/stars/44-99/OpenAlphaStack?style=flat&logo=github)](https://github.com/44-99/OpenAlphaStack/stargazers)
1318

14-
[快速开始](#快速开始) · [架构](docs/architecture.md) · [Skills](docs/skills.md) · [路线图](docs/roadmap.md) · [English](README_EN.md)
19+
[官网](https://44-99.github.io/OpenAlphaStack/) · [快速开始](#快速开始) · [架构](docs/architecture.md) · [Skills](docs/skills.md) · [路线图](docs/roadmap.md)
1520

1621
</div>
1722

23+
<p align="center">
24+
<a href="https://44-99.github.io/OpenAlphaStack/">
25+
<img src="docs/assets/openalphastack-social-preview.png" alt="OpenAlphaStack:Codex MCP + Skills A 股研究插件" width="100%">
26+
</a>
27+
</p>
28+
1829
OpenAlphaStack 将 A 股领域 Skills 与本地 MCP 服务打包为一个可安装的
1930
Codex 插件。Codex Desktop 负责对话、研究和定时任务;MCP 提供有类型边界的
2031
行情、风险、回测与模拟计划工具;Python 负责确定性校验和机械执行,不会自行
@@ -25,6 +36,27 @@ Codex 插件。Codex Desktop 负责对话、研究和定时任务;MCP 提供
2536

2637
> 仅用于研究、回测与模拟交易。OpenAlphaStack 不连接真实券商下单,也不承诺任何投资收益。
2738
39+
## 实机演示
40+
41+
<p align="center">
42+
<img src="docs/assets/openalphastack-demo.gif" alt="OpenAlphaStack 搜索 A 股、查看 K 线和审计三阶段工作流的实机演示" width="960">
43+
</p>
44+
45+
<table>
46+
<tr>
47+
<td width="50%"><img src="docs/assets/dashboard-search-results.png" alt="按中文名称搜索贵州茅台"></td>
48+
<td width="50%"><img src="docs/assets/dashboard-workflow.png" alt="Research、Execution、Evaluation 三阶段审计工作流"></td>
49+
</tr>
50+
<tr>
51+
<td align="center"><strong>股票搜索与行情工作台</strong><br>支持代码、中文名称中的连续字符与拼音首字母。</td>
52+
<td align="center"><strong>三阶段可观测工作流</strong><br>研究、确定性执行与评估各自保持清晰边界。</td>
53+
</tr>
54+
</table>
55+
56+
上图来自本地模拟盘实机,不代表投资收益。Dashboard 默认仅监听
57+
`127.0.0.1`[静态官网](https://44-99.github.io/OpenAlphaStack/) 只展示产品与文档,
58+
不会公开本地账户、行情服务或执行接口。
59+
2860
## 为什么是 OpenAlphaStack?
2961

3062
- **一个插件,两层扩展能力**:用 Codex Skills 承载可复用研究方法,用 MCP
@@ -239,6 +271,8 @@ openalphastack engine stop <paper_run_id>
239271

240272
## 文档
241273

274+
- [静态官网](https://44-99.github.io/OpenAlphaStack/)
275+
- [宣传素材与安全表述](docs/media-kit.md)
242276
- [架构](docs/architecture.md)
243277
- [路线图](docs/roadmap.md)
244278
- [Skills](docs/skills.md)

README_EN.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,30 @@
22

33
<h1>OpenAlphaStack</h1>
44

5+
<p>
6+
<a href="README.md">简体中文</a> ·
7+
<a href="README_EN.md">English</a>
8+
</p>
9+
510
<p><strong>An open-source Codex plugin stack for auditable A-share research, backtesting, and paper trading.</strong></p>
611

712
[![CI](https://github.com/44-99/OpenAlphaStack/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/44-99/OpenAlphaStack/actions/workflows/ci.yml)
813
[![License: MIT](https://img.shields.io/badge/license-MIT-2563eb.svg)](LICENSE)
914
[![Python](https://img.shields.io/badge/python-3.10%2B-3776ab.svg?logo=python&logoColor=white)](pyproject.toml)
1015
[![Codex Plugin](https://img.shields.io/badge/Codex-plugin-111827.svg)](.codex-plugin/plugin.json)
1116
[![MCP](https://img.shields.io/badge/MCP-local--first-1f9d8a.svg)](.mcp.json)
17+
[![GitHub stars](https://img.shields.io/github/stars/44-99/OpenAlphaStack?style=flat&logo=github)](https://github.com/44-99/OpenAlphaStack/stargazers)
1218

13-
[简体中文](README.md) · [Architecture](docs/architecture.md) · [Skills](docs/skills.md) · [Roadmap](docs/roadmap.md)
19+
[Website](https://44-99.github.io/OpenAlphaStack/en.html) · [Quick start](#quick-start) · [Architecture](docs/architecture.md) · [Skills](docs/skills.md) · [Roadmap](docs/roadmap.md)
1420

1521
</div>
1622

23+
<p align="center">
24+
<a href="https://44-99.github.io/OpenAlphaStack/en.html">
25+
<img src="docs/assets/openalphastack-social-preview.png" alt="OpenAlphaStack: Codex MCP and Skills for auditable A-share research" width="100%">
26+
</a>
27+
</p>
28+
1729
OpenAlphaStack packages A-share domain Skills and a typed local MCP server as a
1830
Codex plugin. Codex Desktop owns conversations, research and schedules. Python
1931
owns deterministic validation, T+1 rules, fees, account state and paper
@@ -26,6 +38,16 @@ China's A-share market, and MCP/Codex tool builders evaluating the architecture.
2638
> Research, backtesting and paper trading only. OpenAlphaStack does not place
2739
> real orders or promise investment returns.
2840
41+
## See it in action
42+
43+
<p align="center">
44+
<img src="docs/assets/openalphastack-demo.gif" alt="OpenAlphaStack stock search, K-line dashboard and three-stage workflow demo" width="960">
45+
</p>
46+
47+
The recording comes from the local paper-trading Dashboard. The public
48+
[website](https://44-99.github.io/OpenAlphaStack/en.html) is static and never
49+
exposes local account data, market-data services, or execution endpoints.
50+
2951
## What it provides
3052

3153
- Codex Skills for market analysis, screening, stock analysis and T0 research.
@@ -73,6 +95,9 @@ Desktop and invoke one of the packaged Skills.
7395
For the full setup, safety contract, engine commands and verification workflow,
7496
use the canonical [Simplified Chinese README](README.md).
7597

98+
Reusable screenshots, the demo GIF, and publication boundaries are documented
99+
in the [media kit](docs/media-kit.md).
100+
76101
## License
77102

78103
MIT © OpenAlphaStack
313 KB
Loading
317 KB
Loading
-819 KB
Binary file not shown.

docs/assets/dashboard-workflow.png

523 KB
Loading
3.73 MB
Loading
230 KB
Loading

docs/assets/website-home.png

390 KB
Loading

0 commit comments

Comments
 (0)