Skip to content

Commit d7107ba

Browse files
committed
fix: architecture doccs syntax
1 parent 68a5b38 commit d7107ba

File tree

3 files changed

+24
-23
lines changed

3 files changed

+24
-23
lines changed

etc/architecture/overview.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -15,39 +15,39 @@ Dojo.js is organized as a set of focused packages that cooperate to index, query
1515

1616
```mermaid
1717
flowchart LR
18-
subgraph OnChain
18+
subgraph "On Chain"
1919
World[Dojo World Contracts]
2020
end
2121
22-
subgraph Indexer & Messaging
23-
ToriiIndexer[Torii Service\nHTTP/WebSocket/gRPC]
22+
subgraph "Indexer & Messaging"
23+
ToriiIndexer["Torii Service<br/>HTTP / WebSocket / gRPC"]
2424
end
2525
26-
subgraph CoreClient
27-
CoreProvider[@dojoengine/core\nRpcProvider & World ABI]
28-
ToriiWasm[@dojoengine/torii-wasm\n+ torii-client shim]
29-
GrpcClient[@dojoengine/grpc\nToriiGrpcClient]
30-
Internal[@dojoengine/internal\nSchema & Query Toolkit]
31-
SDK[@dojoengine/sdk\ninit/createSDK]
26+
subgraph "Core Client"
27+
CoreProvider["@dojoengine/core<br/>RPC Provider & World ABI"]
28+
ToriiWasm["@dojoengine/torii-wasm<br/>+ torii-client shim"]
29+
GrpcClient["@dojoengine/grpc<br/>ToriiGrpcClient"]
30+
Internal["@dojoengine/internal<br/>Schema & Query Toolkit"]
31+
SDK["@dojoengine/sdk<br/>init/createSDK"]
3232
end
3333
34-
subgraph App Integrations
35-
StatePkg[@dojoengine/state\nZustand & RECS stores]
36-
ReactPkg[@dojoengine/react\nHooks & RX bindings]
37-
Burner[@dojoengine/create-burner\nLocal wallets]
38-
Predeployed[@dojoengine/predeployed-connector\nInjected connector]
34+
subgraph "App Integrations"
35+
StatePkg["@dojoengine/state<br/>Zustand & RECS stores"]
36+
ReactPkg["@dojoengine/react<br/>Hooks & RX bindings"]
37+
Burner["@dojoengine/create-burner<br/>Local wallets"]
38+
Predeployed["@dojoengine/predeployed-connector<br/>Injected connector"]
3939
UtilsPkg[@dojoengine/utils]
4040
end
4141
42-
subgraph Tooling
43-
Scaffolder[@dojoengine/create-dojo\nCLI scaffolds]
42+
subgraph "Tooling"
43+
Scaffolder["@dojoengine/create-dojo<br/>CLI scaffolds"]
4444
Examples[Examples & Templates]
4545
end
4646
47-
World -- events & state --> ToriiIndexer
48-
CoreProvider -- invoke/call --> World
49-
ToriiIndexer -- queries/subscriptions --> ToriiWasm
50-
ToriiIndexer -- gRPC streams --> GrpcClient
47+
World -- "events & state" --> ToriiIndexer
48+
CoreProvider -- "invoke / call" --> World
49+
ToriiIndexer -- "queries / subscriptions" --> ToriiWasm
50+
ToriiIndexer -- "gRPC streams" --> GrpcClient
5151
ToriiWasm --> SDK
5252
GrpcClient --> SDK
5353
Internal --> SDK

etc/architecture/whats-next.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ This roadmap captures the near-to-mid term architecture initiatives planned for
2929
3. Provide dependency injection hooks in SDK/provider constructors and document how to supply alternative transports.
3030
- **Deliverables**: Adapter interfaces, default Starknet.js implementation, updated dependency guidelines.
3131

32-
## 4. TanStack/DB Integration
32+
## 4. TanStack DB Integration
3333

3434
- **Objective**: Leverage TanStack DB for richer client-side entity persistence, caching, and querying.
3535
- **Key Steps**:
@@ -58,5 +58,6 @@ This roadmap captures the near-to-mid term architecture initiatives planned for
5858

5959
## Cross-Cutting Considerations
6060

61+
- Maintain incremental delivery via stacked `jj` changes to keep reviews focused.
6162
- Prioritise documentation and migration notes alongside each feature.
6263
- Invest in automated tests and benchmarks as new abstractions are introduced to safeguard performance and developer experience.

etc/knowledge-base.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
## Architecture Snapshot (Main Branch)
44

5-
- Reference diagram: [docs/architecture/overview.md](architecture/overview.md)
5+
- Reference diagram: [etc/architecture/overview.md](architecture/overview.md)
66
- Highlights:
77
- `@dojoengine/sdk` connects Torii indexer clients, message signing, and schema parsing for app consumption.
88
- `@dojoengine/core` offers the `DojoProvider` Starknet RPC interface for direct world contract access.
99
- `@dojoengine/grpc` provides streaming access to Torii via the `ToriiGrpcClient` and related mappers.
1010
- UI/state layers (`@dojoengine/state`, `@dojoengine/react`) build on the SDK for entity subscriptions and optimistic updates.
1111
- Tooling packages (`create-burner`, `predeployed-connector`, `create-dojo`) streamline wallet setup and application scaffolding.
1212

13-
_Last updated: 2025-09-25T13:27:58Z
13+
_Last updated: 2025-09-25T19:22:04Z

0 commit comments

Comments
 (0)