Skip to content

Commit c8af45c

Browse files
committed
docs(reference): fix mermaid graph
1 parent 8e961d9 commit c8af45c

File tree

6 files changed

+1589
-604
lines changed

6 files changed

+1589
-604
lines changed

ARCHITECTURE.md

Lines changed: 24 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -21,38 +21,31 @@
2121
### 1.1 High-Level Subsystems
2222

2323
```mermaid
24+
2425
graph TB
25-
CLI[CLI Layer<br/>src/cli/]
26-
Config[Configuration<br/>src/config/]
27-
Core[Core Engine<br/>src/core/]
28-
Progress[Progress Manager<br/>src/progress/]
29-
Reporters[Reporters<br/>src/reporters/]
30-
Storage[History Storage<br/>src/storage/]
31-
Types[Type Definitions<br/>src/types/]
32-
33-
CLI --> Config
34-
CLI --> Core
35-
CLI --> Progress
36-
CLI --> Reporters
37-
CLI --> Storage
38-
39-
Core --> Config
40-
Core --> Progress
41-
Core --> Reporters
42-
Core --> Storage
43-
Core --> Types
44-
45-
Config --> Types
46-
Progress --> Types
47-
Reporters --> Types
48-
Storage --> Types
49-
50-
Core -.->|wraps| TinyBench[TinyBench<br/>External]
51-
52-
style CLI fill:#e1f5ff
53-
style Core fill:#fff4e1
54-
style Storage fill:#f0e1ff
55-
style TinyBench fill:#ffe1e1
26+
subgraph CLI["CLI Layer"]
27+
Entry[CLI Entry]
28+
end
29+
30+
subgraph Core["Core Engines"]
31+
Abstract[Abstract Engines]
32+
Tinybench[TinybenchEngine]
33+
Accurate[AccurateEngine]
34+
end
35+
36+
subgraph Services["Services & Subsystems"]
37+
Config[Configuration]
38+
Progress[Progress]
39+
Reporters[Reporters]
40+
Storage[History]
41+
Types[Types]
42+
end
43+
44+
Entry --> Abstract
45+
Abstract -.-> Tinybench
46+
Abstract -.-> Accurate
47+
Abstract --> Services
48+
5649
```
5750

5851
### 1.2 Subsystem Breakdown
@@ -187,11 +180,6 @@ graph TB
187180
188181
Tinybench -->|Delegates to| TinybenchLib[tinybench library]
189182
Accurate -->|Uses| V8[V8 Intrinsics<br/>+ Node hrtime]
190-
191-
style Abstract fill:#fff4e1
192-
style Tinybench fill:#e1f5ff
193-
style Accurate fill:#e1ffe1
194-
style TinybenchLib fill:#ffe1e1
195183
```
196184

197185
**Abstract Base Class**: `src/core/engine.ts`
@@ -1137,10 +1125,6 @@ flowchart TB
11371125
Reporters -->|Write Files| FS
11381126
Reporters -->|Print Output| Terminal
11391127
History -->|Read/Write| FS
1140-
1141-
style CLI fill:#e1f5ff
1142-
style Services fill:#fff4e1
1143-
style External fill:#ffe1e1
11441128
```
11451129

11461130
### 11.2 Reporter Lifecycle

astro.config.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import starlight from '@astrojs/starlight';
2+
import starlightClientMermaid from '@pasqal-io/starlight-client-mermaid';
23
import { defineConfig } from 'astro/config';
34

45
// https://astro.build/config
@@ -12,6 +13,7 @@ export default defineConfig({
1213
logo: {
1314
src: './assets/logo-no-text-64.png',
1415
},
16+
plugins: [starlightClientMermaid()],
1517
sidebar: [
1618
{ label: 'Getting Started', link: '/getting-started/' },
1719
{

cspell.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,8 @@
6565
"xticks",
6666
"tolist",
6767
"seti",
68-
"asciinema"
68+
"asciinema",
69+
"pasqal"
6970
],
7071
"words": ["bupkis", "deoptimization"]
7172
}

0 commit comments

Comments
 (0)