Skip to content

Commit 884dab2

Browse files
committed
Add sequence diagram
1 parent 4cf8e45 commit 884dab2

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

docs/explanation.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,24 @@ Wagtail Translate operates at the model level and does not include a user interf
2424
Wagtail Translate listens for Wagtail's `copy_for_translation_done` signal to initiate the machine translation.
2525
Wagtail Translate is indifferent on who sends the signal. This could be Simple Translation, other products, or custom code.
2626

27+
The default behavior:
28+
```mermaid
29+
sequenceDiagram
30+
actor User
31+
box Teal Your web-application
32+
participant Wagtail
33+
participant Wagtail Translate
34+
end
35+
participant Translation Service
36+
37+
User->>Wagtail: Translate page
38+
Wagtail->>Wagtail Translate: Fire 'copy for translation done' signal
39+
Wagtail Translate->>Translation Service: Request translation
40+
Translation Service->>Wagtail Translate: Return translated text
41+
Wagtail Translate->>Wagtail: Save revision
42+
User->>Wagtail: Publish page
43+
```
44+
2745
## Customizing default behaviors
2846

2947
Wagtail Translate is designed to be flexible, allowing you to tailor its behavior to your needs.

0 commit comments

Comments
 (0)