feat(provider): Complete first draft of provider docs with diagram
This commit is contained in:
parent
92a1f4c1c5
commit
3fff08f9d7
5 changed files with 174 additions and 157 deletions
|
|
@ -85,15 +85,15 @@ specification {
|
|||
model {
|
||||
mySystem = system 'My System' {
|
||||
description 'System description'
|
||||
|
||||
|
||||
backend = service 'Backend API' {
|
||||
description 'REST API service'
|
||||
}
|
||||
|
||||
|
||||
db = database 'Database' {
|
||||
description 'PostgreSQL database'
|
||||
}
|
||||
|
||||
|
||||
backend -> db 'reads/writes'
|
||||
}
|
||||
}
|
||||
|
|
@ -101,9 +101,9 @@ model {
|
|||
views {
|
||||
view systemOverview {
|
||||
title "System Overview"
|
||||
|
||||
|
||||
include mySystem
|
||||
|
||||
|
||||
autoLayout TopBottom
|
||||
}
|
||||
}
|
||||
|
|
@ -139,7 +139,7 @@ Parameters:
|
|||
|
||||
1. **Edit Models**
|
||||
- Modify `.c4` files in `models/` or `views/`
|
||||
|
||||
|
||||
2. **Preview Changes**
|
||||
```bash
|
||||
cd resources/edp-likec4 # or doc-likec4
|
||||
|
|
@ -216,7 +216,7 @@ specification {
|
|||
element system
|
||||
element container
|
||||
element component
|
||||
|
||||
|
||||
relationship async
|
||||
relationship sync
|
||||
}
|
||||
|
|
@ -231,19 +231,19 @@ model {
|
|||
customer = person 'Customer' {
|
||||
description 'End user'
|
||||
}
|
||||
|
||||
|
||||
system = system 'My System' {
|
||||
frontend = container 'Frontend' {
|
||||
description 'React application'
|
||||
}
|
||||
|
||||
|
||||
backend = container 'Backend' {
|
||||
description 'Node.js API'
|
||||
}
|
||||
|
||||
|
||||
frontend -> backend 'API calls'
|
||||
}
|
||||
|
||||
|
||||
customer -> system.frontend 'uses'
|
||||
}
|
||||
```
|
||||
|
|
@ -256,17 +256,17 @@ Create diagrams:
|
|||
views {
|
||||
view overview {
|
||||
title "System Overview"
|
||||
|
||||
|
||||
include *
|
||||
|
||||
|
||||
autoLayout TopBottom
|
||||
}
|
||||
|
||||
|
||||
view systemDetail {
|
||||
title "System Details"
|
||||
|
||||
|
||||
include system.*
|
||||
|
||||
|
||||
autoLayout LeftRight
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue