Skip to content

Commit 7d53eb5

Browse files
docs: mermaid flowchart
1 parent 832f977 commit 7d53eb5

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,44 @@
22

33
Core System API defined using TypeSpec
44

5+
```mermaid
6+
flowchart TD
7+
A[pnpm clean<br/>Clean Generated Files]
8+
9+
B[Write TypeSpec]
10+
C[pnpm format<br/>Prettier Formatting]
11+
12+
D[compile:openapi<br/>Generate OpenAPI]
13+
E[patch-openapi.js<br/>Fix Type / Description]
14+
F[Official OpenAPI Spec]
15+
%% From TypeSpec to OpenAPI
16+
A --> B --> C --> D --> E --> F
17+
18+
%% Mock
19+
F --> M[Prism Mock Server<br/>pnpm start:mock]
20+
21+
%% Docs generation from OpenAPI
22+
F --> S[Swagger UI]
23+
F --> T[Scala]
24+
F --> Y[Yaak Collection<br/>build:yaak]
25+
F --> R[Redocly<br/>build:redocly]
26+
27+
%% SDK generation
28+
F --> O[orval Generate SDK<br/>build:sdk]
29+
O --> CSDK[pnpm compile:sdk]
30+
CSDK --> NPM[Publish to npm]
31+
NPM --> FE[Frontend Repo<br/>Install Usage]
32+
33+
%% SDK docs
34+
O --> TDOC[TypeDoc<br/>SDK Documentation build:typedoc]
35+
36+
%% Deploy
37+
R --> GH[GitHub Pages]
38+
S --> GH
39+
T --> GH
40+
TDOC --> GH
41+
```
42+
543
## Dependencies
644

745
Please install [Node.js](https://nodejs.org/) and [pnpm](https://pnpm.io/) first.

0 commit comments

Comments
 (0)