Skip to content

Commit be68695

Browse files
docs: update ADR references to /docs
1 parent b52a203 commit be68695

14 files changed

Lines changed: 54 additions & 53 deletions

File tree

docs/DEBUGGING-GUIDE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,6 @@ Bug reported
233233
| [`bot-api/tests/TESTING-GUIDE.md`](../bot-api/tests/TESTING-GUIDE.md) | Intent-capture protocol, MockedServer gates, Bot vs BaseBot |
234234
| [`bot-api/tests/TEST-REGISTRY.md`](../bot-api/tests/TEST-REGISTRY.md) | Acceptance test IDs and cross-platform coverage |
235235
| [`runner/README.md`](../runner/README.md) | Full Battle Runner API reference |
236-
| [ADR-0037](architecture/adr/0037-functional-core-bot-api-testability.md) | Functional core extraction for Bot API |
237-
| [ADR-0038](architecture/adr/0038-shared-cross-platform-test-definitions.md) | Shared test definitions and parity policy |
238-
| [ADR-0039](architecture/adr/0039-server-testability.md) | Server physics test framework |
236+
| [ADR-0037](/docs/decisions/0037-functional-core-bot-api-testability.md) | Functional core extraction for Bot API |
237+
| [ADR-0038](/docs/decisions/0038-shared-cross-platform-test-definitions.md) | Shared test definitions and parity policy |
238+
| [ADR-0039](/docs/decisions/0039-server-testability.md) | Server physics test framework |

docs/INDEX.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@
55
| [README.md](./README.md) | Overview and entry point for internal engineering documentation |
66
| [DEBUGGING-GUIDE.md](./DEBUGGING-GUIDE.md) | Debugging patterns, timing issues, and diagnostics reference |
77
| [architecture/](./architecture/) | ADRs, C4 views, domain models, and business flows |
8+
| [decisions/](./decisions/) | Architecture Decision Records (ADRs) — canonical list with statuses and dates |

docs/architecture/INDEX.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
| File / Directory | Type | Purpose |
44
|-----------------|------|---------|
55
| [README.md](./README.md) | Entry point | Navigation hub — ADRs, C4 views, message schemas, business flows |
6-
| [adr/](./adr/) | Directory | Architecture Decision Records (Why) |
6+
| [decisions/](../decisions/) | Directory | Architecture Decision Records (Why) |
77
| [c4-views/](./c4-views/) | Directory | C4 diagrams — System Context, Container, Component views (What/Visual) |
88
| [models/](./models/) | Directory | Message schemas and business flows (What/Detailed + How) |

docs/architecture/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,16 @@ Comprehensive architecture documentation for Robocode Tank Royale following the
77
## 🎯 Quick Navigation
88

99
### **Architecture Decision Records (ADRs)** — The "Why"
10-
**[👉 adr/](./adr/)**
10+
**[👉 Decisions](/docs/decisions/README.md)**
1111

12-
Why key architectural decisions were made. See **[adr/README.md](./adr/README.md)** for the full index with statuses and dates.
12+
Why key architectural decisions were made. See **[Decisions](/docs/decisions/README.md)** for the full index with statuses and dates.
1313

1414
**Use When:** Understanding design rationale, trade-offs, alternatives
1515

1616
---
1717

1818
### **C4 Architecture Diagrams** — The "What" (Visual)
19-
**[👉 c4-views/](./c4-views/)**
19+
**[👉 C4-views/](./c4-views/)**
2020

2121
Hierarchical system visualization at multiple zoom levels:
2222
-[**System Context**](./c4-views/system-context.md) — High-level 10,000-foot view
@@ -63,7 +63,7 @@ How entities interact through processes:
6363

6464
### ADRs (Architecture Decision Records)
6565

66-
See **[adr/README.md](./adr/README.md)** for the full canonical ADR index with dates and statuses.
66+
See **[Decisions](/docs/decisions/README.md)** for the full canonical ADR index with dates and statuses.
6767

6868
### Message Schema
6969
| Category | Coverage | Status |
@@ -113,12 +113,12 @@ See **[adr/README.md](./adr/README.md)** for the full canonical ADR index with d
113113

114114
### For **Server Developers**
115115
1. All message schemas ([Handshakes](./models/message-schema/handshakes.md), [Commands](./models/message-schema/commands.md), [Events](./models/message-schema/events.md), [Intents](./models/message-schema/intents.md), [State](./models/message-schema/state.md))
116-
2. [ADR-0011: Game Loop](./adr/0011-realtime-game-loop-architecture.md) — Timing & determinism
116+
2. [ADR-0011: Game Loop](/docs/decisions/0011-realtime-game-loop-architecture.md) — Timing & determinism
117117
3. [Turn Execution Flow](./models/flows/turn-execution.md) — 15-step sequence
118118
4. [Battle Lifecycle Flow](./models/flows/battle-lifecycle.md) — State machine
119119

120120
### For **System Designers**
121-
1. [ADR index](./adr/) — All architectural decisions and their rationale
121+
1. [Decisions](/docs/decisions/README.md) — All architectural decisions and their rationale
122122
2. System Context and Container diagrams
123123
3. All message schemas and state objects
124124
4. Flow state machines
@@ -165,7 +165,7 @@ Business Flows: 4
165165
| Question | Answer |
166166
|----------|--------|
167167
| **New to Tank Royale?** | Start with [System Context](./c4-views/system-context.md) |
168-
| **Why this architecture?** | Check the [ADRs](./adr/) |
168+
| **Why this architecture?** | Check the [Decisions](/docs/decisions/README.md) |
169169
| **What messages are exchanged?** | Browse [Message Schema](./models/message-schema/) |
170170
| **How do processes work?** | See [Business Flows](./models/flows/) |
171171
| **Building bot code?** | Reference [Handshakes](./models/message-schema/handshakes.md) + [Events](./models/message-schema/events.md) + [Intents](./models/message-schema/intents.md) |

docs/architecture/c4-views/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ Think of it like Google Maps: zoom out to see the country, zoom in to see street
3131

3232
## Related Documentation
3333

34-
- **[ADRs](../adr/)** — Why architectural decisions were made
35-
- **[Message Schema](../models/message-schema/)** — WebSocket message contracts
36-
- **[Business Flows](../models/flows/)** — Process documentation
37-
- **[OpenSpec](../../../openspec/)** — Detailed specifications
34+
- **[ADRs](/docs/decisions/README.md)** — Why architectural decisions were made
35+
- **[Message Schema](../models/message-schema/README.md)** — WebSocket message contracts
36+
- **[Business Flows](../models/flows/README.md)** — Process documentation
37+
- **[OpenSpec](/openspec/project.md)** — Detailed specifications
3838

3939
---
4040

docs/architecture/c4-views/system-context.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -226,9 +226,9 @@ This design choice ensures:
226226

227227
## Related Documentation
228228

229-
- **[ADR-0009: WebSocket Protocol](../adr/0009-websocket-communication-protocol.md)** — Why WebSocket was chosen
230-
- **[ADR-0003: Cross-Platform Bot APIs](../adr/0003-cross-platform-bot-api-strategy.md)** — Multi-language support strategy
231-
- **[ADR-0011: Real-Time Game Loop](../adr/0011-realtime-game-loop-architecture.md)** — Real-time 30 TPS tick system
229+
- **[ADR-0009: WebSocket Protocol](/docs/decisions/0009-websocket-communication-protocol.md)** — Why WebSocket was chosen
230+
- **[ADR-0003: Cross-Platform Bot APIs](/docs/decisions/0003-cross-platform-bot-api-strategy.md)** — Multi-language support strategy
231+
- **[ADR-0011: Real-Time Game Loop](/docs/decisions/0011-realtime-game-loop-architecture.md)** — Real-time 30 TPS tick system
232232
- **[Battle Lifecycle Flow](../models/flows/battle-lifecycle.md)** — How battles progress
233233
- **[Bot Connection Flow](../models/flows/bot-connection.md)** — Bot connection sequence
234234

docs/architecture/models/flows/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -131,10 +131,10 @@ These flow diagrams are the **single canonical source** for all protocol sequenc
131131

132132
## Related Documentation
133133

134-
- **[Message Schema](../message-schema/)** — WebSocket message contracts
135-
- **[Schema YAML Definitions](/schema/schemas/)** — Actual message format definitions
136-
- **[ADRs](../../adr/)** — Design decisions about flow architecture
137-
- **[C4 Views](../../c4-views/)** — Component interactions
134+
- **[Message Schema](../message-schema/README.md)** — WebSocket message contracts
135+
- **[Schema YAML Definitions](/schema/schemas/README.md)** — Actual message format definitions
136+
- **[ADRs](../../../decisions/README.md)** — Design decisions about flow architecture
137+
- **[C4 Views](../../c4-views/README.md)** — Component interactions
138138

139139
---
140140

docs/architecture/models/flows/battle-lifecycle.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -626,9 +626,9 @@ gantt
626626
- **[Message Schema](../message-schema/README.md)** — WebSocket message contracts
627627
- **[Events](../message-schema/events.md)** — Event message definitions
628628
- **[Commands](../message-schema/commands.md)** — Controller command definitions
629-
- **[ADR-0011: Real-Time Game Loop Architecture](../../adr/0011-realtime-game-loop-architecture.md)** — Design rationale
630-
- **[ADR-0033: Server Debug Mode](../../adr/0033-bot-debug-mode.md)** — Turn-by-turn stepping
631-
- **[ADR-0034: Breakpoint Mode](../../adr/0034-breakpoint-mode.md)** — Per-bot breakpoint pause
629+
- **[ADR-0011: Real-Time Game Loop Architecture](/docs/decisions/0011-realtime-game-loop-architecture.md)** — Design rationale
630+
- **[ADR-0033: Server Debug Mode](/docs/decisions/0033-bot-debug-mode.md)** — Turn-by-turn stepping
631+
- **[ADR-0034: Breakpoint Mode](/docs/decisions/0034-breakpoint-mode.md)** — Per-bot breakpoint pause
632632

633633
---
634634

docs/architecture/models/flows/bot-connection.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -567,9 +567,9 @@ netstat -an | grep 7654
567567
- **[Turn Execution Flow](./turn-execution.md)** — What happens after game starts
568568
- **[Handshakes](../message-schema/handshakes.md)** — Handshake message schemas
569569
- **[Events](../message-schema/events.md)** — Event message schemas
570-
- **[ADR-0009: WebSocket Protocol](../../adr/0009-websocket-communication-protocol.md)** — Protocol design
571-
- **[ADR-0003: Cross-Platform Bot APIs](../../adr/0003-cross-platform-bot-api-strategy.md)** — API design
572-
- **[ADR-0035: Bot Debugger Detection](../../adr/0035-bot-debugger-detection.md)**`debuggerAttached` field
570+
- **[ADR-0009: WebSocket Protocol](/docs/decisions/0009-websocket-communication-protocol.md)** — Protocol design
571+
- **[ADR-0003: Cross-Platform Bot APIs](/docs/decisions/0003-cross-platform-bot-api-strategy.md)** — API design
572+
- **[ADR-0035: Bot Debugger Detection](/docs/decisions/0035-bot-debugger-detection.md)**`debuggerAttached` field
573573

574574
---
575575

docs/architecture/models/flows/event-handling.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -653,8 +653,8 @@ Both calls must happen in sequence for handler output to appear in the GUI.
653653
- **[Battle Lifecycle Flow](./battle-lifecycle.md)** — When round ends and events fire
654654
- **[Bot Connection Flow](./bot-connection.md)** — Event handler setup during initialization
655655
- **[Message Schema: Events](../message-schema/events.md)** — Event message contracts
656-
- **[ADR-0011: Realtime Game Loop](../../adr/0011-realtime-game-loop-architecture.md)** — Design decisions about event timing
657-
- **[ADR-0012: Turn Timing Semantics](../../adr/0012-turn-timing-semantics.md)** — Exact timing semantics
656+
- **[ADR-0011: Realtime Game Loop](/docs/decisions/0011-realtime-game-loop-architecture.md)** — Design decisions about event timing
657+
- **[ADR-0012: Turn Timing Semantics](/docs/decisions/0012-turn-timing-semantics.md)** — Exact timing semantics
658658

659659
---
660660

0 commit comments

Comments
 (0)