Skip to content

Commit 6750323

Browse files
authored
Merge pull request #161 from MeshJS/feature/docs-graph
Add documentation graph to README.md for module relationships
2 parents a41b8ed + 488a34f commit 6750323

File tree

1 file changed

+117
-0
lines changed

1 file changed

+117
-0
lines changed

README.md

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,123 @@ A comprehensive, enterprise-grade multi-signature wallet solution built on Carda
9090
- **UTxO Management**: Advanced UTxO handling
9191
- **Transaction Building**: Comprehensive transaction construction
9292

93+
## Documentation Graph
94+
95+
This graph shows internal module relationships in this repository. Arrows mean "imports/depends on".
96+
97+
```mermaid
98+
graph TD
99+
100+
pages["src/pages"]
101+
102+
components_common["src/components/common"]
103+
104+
components_multisig["src/components/multisig"]
105+
106+
components_ui["src/components/ui"]
107+
108+
hooks["src/hooks"]
109+
110+
lib["src/lib"]
111+
112+
utils["src/utils"]
113+
114+
types["src/types"]
115+
116+
data["src/data"]
117+
118+
config_wallet["src/config/wallet.ts"]
119+
120+
server_api["src/server/api"]
121+
122+
server_auth["src/server/auth.ts"]
123+
124+
server_db["src/server/db.ts"]
125+
126+
prisma["prisma/*"]
127+
128+
129+
subgraph legend["Legend"]
130+
l1["A --> B means A imports/depends on B"]
131+
l2["Click nodes to open local paths"]
132+
end
133+
134+
135+
%% Frontend relationships
136+
pages --> components_common
137+
pages --> components_multisig
138+
pages --> components_ui
139+
140+
components_common --> hooks
141+
components_multisig --> hooks
142+
components_ui --> hooks
143+
144+
components_common --> utils
145+
components_multisig --> utils
146+
components_ui --> utils
147+
148+
hooks --> lib
149+
hooks --> types
150+
151+
%% Shared relationships
152+
lib --> utils
153+
lib --> types
154+
data --> lib
155+
data --> components_multisig
156+
config_wallet --> lib
157+
158+
%% Backend relationships
159+
server_api --> lib
160+
server_api --> utils
161+
server_api --> types
162+
server_api --> server_db
163+
server_auth --> server_db
164+
server_auth --> utils
165+
server_db --> types
166+
prisma --> server_db
167+
168+
169+
subgraph frontend
170+
pages
171+
components_common
172+
components_multisig
173+
components_ui
174+
hooks
175+
end
176+
177+
subgraph shared
178+
lib
179+
utils
180+
types
181+
config_wallet
182+
data
183+
end
184+
185+
subgraph backend
186+
server_api
187+
server_auth
188+
server_db
189+
prisma
190+
end
191+
192+
193+
%% Clickable links to local repository paths
194+
click pages "./src/pages" _self
195+
click components_common "./src/components/common" _self
196+
click components_multisig "./src/components/multisig" _self
197+
click components_ui "./src/components/ui" _self
198+
click hooks "./src/hooks" _self
199+
click lib "./src/lib" _self
200+
click utils "./src/utils" _self
201+
click types "./src/types" _self
202+
click data "./src/data" _self
203+
click config_wallet "./src/config/wallet.ts" _self
204+
click server_api "./src/server/api" _self
205+
click server_auth "./src/server/auth.ts" _self
206+
click server_db "./src/server/db.ts" _self
207+
click prisma "./prisma" _self
208+
```
209+
93210
### Database Schema
94211
```prisma
95212
model User {

0 commit comments

Comments
 (0)