From d972117ee0943b744a00cb1fc5e98cc853ca3582 Mon Sep 17 00:00:00 2001 From: Pigbibi <20649888+Pigbibi@users.noreply.github.com> Date: Wed, 7 Oct 2026 21:44:31 +0800 Subject: [PATCH] docs: move project instructions into documentation Co-Authored-By: Codex --- AGENTS.md | 8 ++------ README.md | 2 ++ docs/project-reference.md | 7 +++++++ 3 files changed, 11 insertions(+), 6 deletions(-) create mode 100644 docs/project-reference.md diff --git a/AGENTS.md b/AGENTS.md index 88ff087..ab08cb9 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,7 +1,3 @@ -## Repository guardrails - -- This is a research-only repository. Do not add broker credentials, order placement, or live allocation logic here. -- Keep checks small and bounded. Prefer targeted tests over full-suite or data-heavy jobs. -- Do not commit raw licensed market data. Use small synthetic examples or point-in-time derived artifacts. -- Heavy data collection or backtests should run through GitHub Actions or `slowrun bash -lc "..."` from the parent VPS. +# Project documentation +[Project scope and operating reference](docs/project-reference.md). diff --git a/README.md b/README.md index 53077f9..7a458f5 100644 --- a/README.md +++ b/README.md @@ -57,3 +57,5 @@ python -m pytest -q ## License See [LICENSE](LICENSE). + +[Project scope and operating reference](docs/project-reference.md). diff --git a/docs/project-reference.md b/docs/project-reference.md new file mode 100644 index 0000000..37dedfe --- /dev/null +++ b/docs/project-reference.md @@ -0,0 +1,7 @@ +## Repository guardrails + +- This is a research-only repository. Do not add broker credentials, order placement, or live allocation logic here. +- Keep checks small and bounded. Prefer targeted tests over full-suite or data-heavy jobs. +- Do not commit raw licensed market data. Use small synthetic examples or point-in-time derived artifacts. +- For an explicitly authorized heavy collection or backtest, use the approved GitHub Actions job or the parent VPS `slowrun` environment. Reading this file or making a local code change does not authorize remote dispatch or data acquisition. +