Skip to content

Commit 6d2bf95

Browse files
authored
docs: add the memory-management page (#531)
## What Adds `docs/pages/memory-management.md` and links it from the docs index next to "Scratch tables". The page answers one question: how much memory can a run use? It lists the controls (the environment variables and `run_json.py` flags, with their defaults and units), the fixed resident bounds, the scratch formula with a worked example, and what grows with bars, trades and open orders. Every constant and source citation on the page was checked against the source. Docs only: no code and no behaviour change. ## Checks - `lab remote` preflight + docs on a clean tree: preflight passed (59 stages), docs build passed. The doc-anchors gate accepts every citation on the page. - The page was read statically by a second reviewer, who recomputed every number on it. ## Notes for the release The cohort-lookup row and the report-key rows describe the tree at the time of writing; they are re-read against the final release tree before the tag. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
1 parent fd7013e commit 6d2bf95

2 files changed

Lines changed: 243 additions & 0 deletions

File tree

‎docs/pages/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,7 @@ Build the generated strategy module with the repository recipe (or
235235
| [Strategy lifecycle](@ref lifecycle) | Handle ownership, run reuse and report freeing. |
236236
| [Configuration](@ref configuration) | Inputs, `strategy()` overrides, the bar magnifier, trace recording and the trade-start gate. |
237237
| [Scratch tables](@ref scratch_tables) | Disk or bounded memory, the default admission policy, jailed host/HPO setup, typed resource failures and planned jail proof. |
238+
| [Memory management](@ref memory_management) | How much memory a run can use: the controls, the fixed resident bounds, the scratch formula with a worked example, and what grows with bars, trades and open orders. |
238239
| [Report schema](@ref report_schema) | `pf_report_t` field by field, including the equity curve. |
239240
| [Run-failure codes](@ref run_failure_codes) | The stable code and typed arguments beside a failed run's text: the getters, the rules, every code, and the catalog and per-release diff each release publishes. |
240241
| [Trading metrics reference](@ref metrics) | Every `pf_metrics_t` field: units, NaN rules, validation status. |

0 commit comments

Comments
 (0)