Skip to content

[codex] clarify QSL architecture role #181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Pigbibi merged 1 commit into from
Jul 6, 2026
Merged

[codex] clarify QSL architecture role #181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# QuantPlatformKit


## QSL architecture role

- **Layer**: `core`.
- **Responsibility**: shared runtime contracts and platform adapters.
- **Owns**: stable contracts, broker adapters, runtime helpers, notifications, risk utilities.
- **Consumes**: platforms, strategies, pipelines, lifecycle tooling.
- **Must not**: decide which strategy is live or store environment-specific secrets.

[Chinese README](README.zh-CN.md)

> Investing involves risk. This project does not provide investment advice and is for education, research, and engineering review only.
Expand Down
9 changes: 9 additions & 0 deletions README.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# QuantPlatformKit


## QSL 架构角色

- **层级**：`核心共享库`。
- **职责**：共享 runtime contracts 和平台 adapters。
- **事实源/归属**：稳定 contracts、broker adapters、runtime helpers、notifications、risk utilities。
- **消费对象**：platforms、strategies、pipelines、lifecycle tooling。
- **禁止事项**：决定哪个策略 live 或保存环境 secrets。

[English README](README.md)

> 投资有风险。本项目不构成投资建议，仅用于学习、研究和工程审阅。
Expand Down
Loading