Skip to content

Commit bd76bf3

Browse files
author
DavidQ
committed
Added links to README.md
1 parent 6c443a0 commit bd76bf3

1 file changed

Lines changed: 16 additions & 24 deletions

File tree

README.md

Lines changed: 16 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ This repository follows a docs-first game/runtime model, combining a stable engi
2828

2929
## ▶️ Start Here
3030

31-
1. Review the repo model in `docs/README.md`
32-
2. Explore the roadmap in `docs/dev/BIG_PICTURE_ROADMAP.md`
33-
3. Browse samples from `samples/index.html`
34-
4. Explore tools under `tools/`
35-
5. Review engine and architecture boundaries in `docs/architecture/`
36-
6. Follow the workflow in `docs/dev/` and `docs/pr/`
31+
1. Review the repo model in [docs/README.md](docs/README.md)
32+
2. Explore the roadmap in [docs/dev/BIG_PICTURE_ROADMAP.md](docs/dev/BIG_PICTURE_ROADMAP.md)
33+
3. Browse samples from [samples/index.html](samples/index.html)
34+
4. Explore tools under [tools/](tools/)
35+
5. Review engine and architecture boundaries in [docs/architecture/](docs/architecture/)
36+
6. Follow the workflow in [docs/dev/](docs/dev/) and [docs/pr/](docs/pr/)
3737

3838
---
3939

@@ -90,25 +90,17 @@ This repo is designed as a learning system, not just a code dump.
9090

9191
## 🏗️ Architecture Overview
9292

93-
- Engine Layer → `src/engine/`
94-
- Advanced Systems → `src/advanced/`
93+
- Engine Layer → [src/engine/](src/engine/)
94+
- Advanced Systems → [src/advanced/](src/advanced/)
9595
- Tools, samples, and games consume public contracts only
9696

97-
Strict boundaries help preserve:
98-
- Engine stability
99-
- Clean extensibility
100-
- Lower coupling
101-
- Safer long-term evolution
102-
10397
---
10498

10599
## 🔄 Development Workflow
106100

107101
This project uses a structured PR workflow:
108102

109-
```text
110103
PLAN_PR → BUILD_PR → APPLY_PR
111-
```
112104

113105
- One PR per purpose
114106
- Small, surgical changes
@@ -119,19 +111,19 @@ PLAN_PR → BUILD_PR → APPLY_PR
119111

120112
## 📚 Documentation Map
121113

122-
- `docs/README.md` → top-level documentation index
123-
- `docs/architecture/` → durable architecture and boundary contracts
124-
- `docs/pr/` → preserved PR history and architecture evolution
125-
- `docs/dev/` → active workflow controls and implementation planning
126-
- `docs/dev/reports/` → active report artifacts
127-
- `docs/archive/` → archived dev-ops notes and generated reports
114+
- [docs/README.md](docs/README.md) → top-level documentation index
115+
- [docs/architecture/](docs/architecture/) → durable architecture and boundary contracts
116+
- [docs/pr/](docs/pr/) → preserved PR history and architecture evolution
117+
- [docs/dev/](docs/dev/) → active workflow controls and implementation planning
118+
- [docs/dev/reports/](docs/dev/reports/) → active report artifacts
119+
- [docs/archive/](docs/archive/) → archived dev-ops notes and generated reports
128120

129121
---
130122

131123
## ⚠️ Runtime Boundary Rules
132124

133-
- Engine code lives in `src/engine/`
134-
- Advanced systems live in `src/advanced/`
125+
- Engine code lives in [src/engine/](src/engine/)
126+
- Advanced systems live in [src/advanced/](src/advanced/)
135127
- Tools, samples, and games must use public contracts only
136128
- Engine boundaries should not be bypassed
137129

0 commit comments

Comments
 (0)