Skip to content

Commit 84d4659

Browse files
committed
fix(run-engine): move design docs out of the Mintlify docs/ tree; format
check-broken-links parses every .md under docs/ as MDX and can't parse the plain- markdown plan (code/angle brackets), failing CI. These are engine design docs, not user documentation, so relocate docs/superpowers/{plans,references} (plan, findings, research, diagrams) to internal-packages/run-engine/design/ and fix the internal path references. Also run oxfmt on runEngine.server.ts (missed after the review fix wave), fixing code-quality.
1 parent 6247820 commit 84d4659

9 files changed

Lines changed: 11 additions & 12 deletions

apps/webapp/app/v3/runEngine.server.ts

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -106,15 +106,14 @@ function createRunEngine() {
106106
batchMaxSize: env.RUN_ENGINE_TTL_WORKER_BATCH_MAX_SIZE,
107107
batchMaxWaitMs: env.RUN_ENGINE_TTL_WORKER_BATCH_MAX_WAIT_MS,
108108
},
109-
ckVirtualTimeScheduling:
110-
env.RUN_ENGINE_CK_VTIME_SCHEDULING_ENABLED
111-
? {
112-
enabled: true,
113-
quantum: env.RUN_ENGINE_CK_VTIME_QUANTUM,
114-
scanWindowMultiplier: env.RUN_ENGINE_CK_VTIME_WINDOW_MULTIPLIER,
115-
stateTtlSeconds: env.RUN_ENGINE_CK_VTIME_STATE_TTL_SECONDS,
116-
}
117-
: undefined,
109+
ckVirtualTimeScheduling: env.RUN_ENGINE_CK_VTIME_SCHEDULING_ENABLED
110+
? {
111+
enabled: true,
112+
quantum: env.RUN_ENGINE_CK_VTIME_QUANTUM,
113+
scanWindowMultiplier: env.RUN_ENGINE_CK_VTIME_WINDOW_MULTIPLIER,
114+
stateTtlSeconds: env.RUN_ENGINE_CK_VTIME_STATE_TTL_SECONDS,
115+
}
116+
: undefined,
118117
},
119118
runLock: {
120119
redis: {

docs/superpowers/plans/2026-07-23-ck-virtual-time-scheduling-plan.md renamed to internal-packages/run-engine/design/plans/2026-07-23-ck-virtual-time-scheduling-plan.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Implementation and testing plan for the recommendation out of three fairness
44
spikes. The spike harness and benchmark code are archived on the remote branch
55
`chore/fair-queueing-spike` (throwaway, never merged); the findings and research
66
they produced are kept alongside this plan as references:
7-
`docs/superpowers/references/run-queue-fairness-ck-findings.md`,
7+
`internal-packages/run-engine/design/references/run-queue-fairness-ck-findings.md`,
88
`.../run-queue-fairness-caps-vs-scheduling-findings.md`, and
99
`.../run-queue-fairness-research.md`.
1010

@@ -298,7 +298,7 @@ File: `index.ts` (RunQueueOptions, ~line 60).
298298
/**
299299
* Fair (virtual-time / SFQ) ordering across concurrency-key variants of a
300300
* base queue. Off by default; when off, the exact pre-existing Lua commands
301-
* run and no vtime keys are created. See docs/superpowers/plans/
301+
* run and no vtime keys are created. See internal-packages/run-engine/design/plans/
302302
* 2026-07-23-ck-virtual-time-scheduling-plan.md.
303303
*/
304304
ckVirtualTimeScheduling?: {

docs/superpowers/references/README.md renamed to internal-packages/run-engine/design/references/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Run-queue multi-tenant fairness: spike references
22

33
Reference material for the implementation plan
4-
`docs/superpowers/plans/2026-07-23-ck-virtual-time-scheduling-plan.md`. These are
4+
`internal-packages/run-engine/design/plans/2026-07-23-ck-virtual-time-scheduling-plan.md`. These are
55
the findings and the queueing-theory research produced by three throwaway spikes
66
on RunQueue tenant fairness (#2617). The spikes' harness, bench, and results code
77
was throwaway and is NOT on this branch; it is archived on the remote branch

docs/superpowers/references/diagrams/fairness-how-it-works.png renamed to internal-packages/run-engine/design/references/diagrams/fairness-how-it-works.png

File renamed without changes.

docs/superpowers/references/diagrams/fairness-problem-and-fix.png renamed to internal-packages/run-engine/design/references/diagrams/fairness-problem-and-fix.png

File renamed without changes.

docs/superpowers/references/run-queue-fairness-base-queue-findings.md renamed to internal-packages/run-engine/design/references/run-queue-fairness-base-queue-findings.md

File renamed without changes.

docs/superpowers/references/run-queue-fairness-caps-vs-scheduling-findings.md renamed to internal-packages/run-engine/design/references/run-queue-fairness-caps-vs-scheduling-findings.md

File renamed without changes.

docs/superpowers/references/run-queue-fairness-ck-findings.md renamed to internal-packages/run-engine/design/references/run-queue-fairness-ck-findings.md

File renamed without changes.

docs/superpowers/references/run-queue-fairness-research.md renamed to internal-packages/run-engine/design/references/run-queue-fairness-research.md

File renamed without changes.

0 commit comments

Comments
 (0)