Skip to content

Commit b1a9383

Browse files
authored
Merge pull request #11 from flyingrobots/echo/docs-make-open
echo/docs make open
2 parents 290a482 + f165056 commit b1a9383

File tree

8 files changed

+2493
-8
lines changed

8 files changed

+2493
-8
lines changed

Makefile

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ SHELL := /bin/bash
44
PORT ?= 5173
55

66
.PHONY: hooks docs docs-build docs-ci
7-
87
hooks:
98
@git config core.hooksPath .githooks
109
@chmod +x .githooks/* 2>/dev/null || true
@@ -26,7 +25,7 @@ docs:
2625
wait $$server_pid ; \
2726
exit 0 ; \
2827
fi ; \
29-
sleep 0.25 ; \
28+
sleep 1 ; \
3029
done ; \
3130
echo "[docs] Timed out waiting for VitePress." ; \
3231
exit 1

docs/.vitepress/config.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ export default defineConfig({
44
title: 'Echo',
55
description: 'Deterministic, multiverse-aware ECS',
66
cleanUrls: true,
7+
ignoreDeadLinks: [
8+
// Collision tour HTML is added in a separate PR
9+
/^\/collision-dpo-tour\.html$/
10+
],
711
themeConfig: {
812
nav: [
913
{ text: 'Home', link: '/' },
@@ -21,4 +25,7 @@ export default defineConfig({
2125
}
2226
}
2327
})
28+
<<<<<<< HEAD
29+
=======
2430

31+
>>>>>>> origin/main

docs/decision-log.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,3 +60,12 @@
6060
- Decision: Do not disable Prev/Next in "all" mode; allow navigation buttons to toggle into carousel.
6161
- Change: docs/assets/collision/animate.js leaves Prev/Next enabled in 'all'; boundary disabling still applies in single-slide mode.
6262
- Consequence: Users can initiate the carousel via navigation controls; E2E tour test passes deterministically.
63+
64+
## 2025-10-29 — Docs make open (PR #11)
65+
66+
- Context: Make dev docs open automatically; fix routing and dead-link noise.
67+
- Decisions:
68+
- Use a precise dead-link ignore for `/collision-dpo-tour.html` (exact regex) until the page is always present.
69+
- Convert tour/spec links to root‑relative paths to work site‑wide under VitePress routing.
70+
- Make the dev server polling loop portable (`sleep 1`).
71+
- Consequence: Docs dev flow is consistent across environments; CI Docs Guard happy; links resolve from any page.

docs/execution-plan.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ This is Codex’s working map for building Echo. Update it relentlessly—each s
3333

3434
## Today’s Intent
3535

36+
> 2025-10-29 — Docs make open (PR #11)
37+
38+
- VitePress dev: keep auto-open; polling loop uses portable `sleep 1`.
39+
- Fix links and dead-link ignore: root-relative URLs; precise regex for `/collision-dpo-tour.html`; corrected comment typo.
40+
3641
> 2025-10-29 — Docs E2E (PR #10)
3742
3843
- Collision DPO tour carousel: keep Prev/Next enabled in "all" mode so users and tests can enter carousel via navigation. Fixes Playwright tour test.

docs/guide/collision-tour.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ title: Collision DPO Tour
66

77
The interactive tour illustrates how Echo models collision and CCD as DPO graph rewrites.
88

9-
- Launch the tour: [docs/collision-dpo-tour.html](../collision-dpo-tour.html)
9+
- Launch the tour: [docs/collision-dpo-tour.html](/collision-dpo-tour.html)
1010
- Assets live under `docs/assets/collision/`.
1111

1212
Tip: Toggle the World/Graph tabs in the picture-in-picture panel and use the Prev/Next buttons to step through each rule.
13-

docs/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,5 @@ title: Echo Docs
66

77
Deterministic, multiverse-aware ECS.
88

9-
- See the Collision DPO Tour: [Open the interactive HTML](./collision-dpo-tour.html).
10-
- Read the spec: [Geometry & Collision](./spec-geom-collision.md).
11-
9+
- See the Collision DPO Tour: [Open the interactive HTML](/collision-dpo-tour.html).
10+
- Read the spec: [Geometry & Collision](/spec-geom-collision.md).

0 commit comments

Comments
 (0)