Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create system_overview.md #2554

Open
wants to merge 69 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 20 commits
Commits
Show all changes
69 commits
Select commit Hold shift + click to select a range
c6c026a
Create system_overview.md
nitzanballerine Jul 22, 2024
804d2e5
Create workflows_technology.md
nitzanballerine Jul 22, 2024
f63c870
Create creating_a_workflow.md
nitzanballerine Jul 22, 2024
880e180
Create configuring_workflow_steps.md
nitzanballerine Jul 22, 2024
14a04a9
Create creating_a_collection_flow
nitzanballerine Jul 22, 2024
931b683
Create configuring_a_collection_flow.md
nitzanballerine Jul 22, 2024
b5dcec3
Create changing the_collection_flow_design.md
nitzanballerine Jul 22, 2024
5884af0
Create adding rules_step_to_the_workflow.md
nitzanballerine Jul 22, 2024
42bf8c5
Create adding_or_configuring_a_rule.md
nitzanballerine Jul 22, 2024
ccba781
Create adding_or_configuring_a_rule.md
nitzanballerine Jul 22, 2024
1ad8fd3
Create making_a_rule_affect_a_workflow_state.md
nitzanballerine Jul 22, 2024
da1d3b5
Delete websites/docs/src/content/docs/en/learn/Adding directory
nitzanballerine Jul 22, 2024
4de4bff
Create overview_of_case_management.md
nitzanballerine Jul 22, 2024
75b4ae0
Create using_the_case_management_dashboard.md
nitzanballerine Jul 22, 2024
abb4b26
Create customizing_case_management_workflows.md
nitzanballerine Jul 22, 2024
87321fa
Create adding_a_3rd_party_check_to_a_workflow.md
nitzanballerine Jul 22, 2024
4df649f
Create adding_a_child_workflow_to_your_workflow.md
nitzanballerine Jul 22, 2024
d3ccd71
Create adding_a_plugin_to_your_workflow.md
nitzanballerine Jul 22, 2024
543235c
Create how_to_use_webhooks.md
nitzanballerine Jul 22, 2024
6f51432
Update system_overview.md
nitzanballerine Jul 22, 2024
538f612
Update system_overview.md
nitzanballerine Jul 22, 2024
452d433
Rename adding rules_step_to_the_workflow.md to adding_rules_step_to_t…
nitzanballerine Jul 22, 2024
308fe36
Rename changing the_collection_flow_design.md to changing_the_collect…
nitzanballerine Jul 22, 2024
45056d9
Update how_to_use_webhooks.md
nitzanballerine Jul 22, 2024
3afb051
Update and rename configuring_workflow_steps.md to configuring_a_work…
nitzanballerine Jul 22, 2024
4918646
Update system_overview.md
nitzanballerine Jul 22, 2024
96464d8
Update creating_a_workflow.md
nitzanballerine Jul 22, 2024
d3821bb
Update and rename customizing_case_management_workflows.md to Adding_…
nitzanballerine Jul 22, 2024
016bb84
Update system_overview.md
nitzanballerine Jul 22, 2024
a8a36bc
Rename Adding_workflows_to_the_case_management_workflows.md to Adding…
nitzanballerine Jul 22, 2024
f6ac385
Update system_overview.md
nitzanballerine Jul 22, 2024
b56592d
Create invoking_a_workflow.md
nitzanballerine Jul 22, 2024
4d4faea
Update Adding_workflows_to_the_case_management.md
nitzanballerine Jul 22, 2024
992ca90
Update system_overview.md
nitzanballerine Jul 22, 2024
a83dba8
Update and rename Adding_workflows_to_the_case_management.md to add_a…
nitzanballerine Jul 22, 2024
e600b15
Update configuring_a_collection_flow.md
nitzanballerine Jul 22, 2024
0ded653
Update system_overview.md
nitzanballerine Jul 22, 2024
580363a
Update system_overview.md
nitzanballerine Jul 22, 2024
8c7016c
Update adding_a_3rd_party_check_to_a_workflow.md
nitzanballerine Jul 22, 2024
68e32a0
Update case_management_overview.md
nitzanballerine Jul 22, 2024
9e2f715
Update using_the_case_management_dashboard.md
nitzanballerine Jul 22, 2024
8f7c2a0
Update making_a_rule_affect_a_workflow_state.md
nitzanballerine Jul 22, 2024
346ff1b
Update and rename making_a_rule_affect_a_workflow_state.md to adding_…
nitzanballerine Jul 22, 2024
5b51279
Update system_overview.md
nitzanballerine Jul 22, 2024
49137b7
Update system_overview.md
nitzanballerine Jul 23, 2024
d4f8923
Create calculating_risk_scores.md
nitzanballerine Jul 23, 2024
a489018
Update system_overview.md
nitzanballerine Jul 23, 2024
a488ef6
Update introduction.md
nitzanballerine Jul 23, 2024
e131e8d
Update astro.config.mjs
nitzanballerine Jul 23, 2024
4726c0c
chore(backoffice): upddate process tracker plugins name
alonp99 Jul 24, 2024
3c20d0d
Update workflows_technology.md
nitzanballerine Jul 24, 2024
e3b2e8e
Update using_the_case_management_dashboard.md
nitzanballerine Jul 24, 2024
8f85c78
Update invoking_a_workflow.md
nitzanballerine Jul 24, 2024
989e4dc
Update how_to_use_webhooks.md
nitzanballerine Jul 24, 2024
c2e3746
Update creating_a_workflow.md
nitzanballerine Jul 24, 2024
cdc4671
Update configuring_a_workflow.md
nitzanballerine Jul 24, 2024
7180bbd
Update configuring_a_collection_flow.md
nitzanballerine Jul 24, 2024
bf1e129
Update calculating_risk_scores.md
nitzanballerine Jul 24, 2024
464500b
Update adding_rules_and_affect_workflows.md
nitzanballerine Jul 24, 2024
51f4515
Update adding_or_configuring_a_rule.md
nitzanballerine Jul 24, 2024
09e19d3
Update adding_a_plugin_to_your_workflow.md
nitzanballerine Jul 24, 2024
fd358f2
Update adding_rules_step_to_the_workflow.md
nitzanballerine Jul 24, 2024
478484b
Update adding_a_child_workflow_to_your_workflow.md
nitzanballerine Jul 24, 2024
eecb3db
Update adding_a_3rd_party_check_to_a_workflow.md
nitzanballerine Jul 24, 2024
73b9231
Update add_and_customize_workflows_in_the_case_management.md
nitzanballerine Jul 24, 2024
e61945d
Update overview_of_case_management.md
nitzanballerine Jul 24, 2024
1cbbafa
Update system_overview.md
nitzanballerine Jul 24, 2024
ebe10e8
chore(axs): plugin names
alonp99 Jul 24, 2024
2e933a5
chore(axs): plugin names
alonp99 Jul 24, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 106 additions & 0 deletions websites/docs/src/content/docs/en/getting_started/system_overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
# System Overview


Ballerine is a risk management platform for performing all types of risk flows and processes. To do so, Ballerine provides the risk modules needed to build custom risk flows. You can use all modules, combinations of some modules, or just one module to perform a desired risk process.

For example:
- **Build a full KYB flow** using data collection flow, 3rd party vendors, risk rules, and the case management.
- **Build a simple KYC** using 3rd party vendors, risk rules, and the case management.
- **Build a simple digital form** using data collection flow.
- **Manually review documents** using the case management.
- Etc.

### Example flow using Ballerine's modules
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix heading level.

Expected: h2; Actual: h3. Heading levels should only increment by one level at a time.

- ### Example flow using Ballerine's modules
+ ## Example flow using Ballerine's modules
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### Example flow using Ballerine's modules
## Example flow using Ballerine's modules
Tools
Markdownlint

13-13: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time

(MD001, heading-increment)


<img title="Example workflow" alt="Example workflow" src="https://uploads-ssl.webflow.com/62a3bad46800eb4715b2faf1/669ea9cfe853bf03be6dcbc3_Workflow%20example.png">
Comment on lines +16 to +18
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix heading level.

The heading level should be adjusted to increment by one level at a time.

- ### Example flow using Ballerine's modules
+ ## Example flow using Ballerine's modules
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### Example flow using Ballerine's modules
<img title="Example workflow" alt="Example workflow" src="https://uploads-ssl.webflow.com/62a3bad46800eb4715b2faf1/669ea9cfe853bf03be6dcbc3_Workflow%20example.png">
## Example flow using Ballerine's modules
<img title="Example workflow" alt="Example workflow" src="https://uploads-ssl.webflow.com/62a3bad46800eb4715b2faf1/669ea9cfe853bf03be6dcbc3_Workflow%20example.png">
Tools
Markdownlint

19-19: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time

(MD001, heading-increment)




## Workflows
A workflow is the engine that orchestrates the different steps of a risk flow, and how they should interact with each other.
Every workflow is a definition of a flow, made out of Ballerine's different modules.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix wordiness.

The phrase "made out of" is wordy. Consider using "composed of" instead.

- made out of Ballerine's different modules.
+ composed of Ballerine's different modules.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Every workflow is a definition of a flow, made out of Ballerine's different modules.
Every workflow is a definition of a flow, composed of Ballerine's different modules.
Tools
LanguageTool

[style] ~21-~21: ‘made out of’ might be wordy. Consider a shorter alternative.
Context: ...ery workflow is a definition of a flow, made out of Ballerine's different modules. Whenever...

(EN_WORDINESS_PREMIUM_MADE_OUT_OF)

Comment on lines +22 to +24
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix wordiness.

The phrase "made out of" is wordy. Consider using "composed of" instead.

- made out of Ballerine's different modules.
+ composed of Ballerine's different modules.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## Workflows
A workflow is the engine that orchestrates the different steps of a risk flow, and how they should interact with each other.
Every workflow is a definition of a flow, made out of Ballerine's different modules.
## Workflows
A workflow is the engine that orchestrates the different steps of a risk flow, and how they should interact with each other.
Every workflow is a definition of a flow, composed of Ballerine's different modules.
Tools
LanguageTool

[style] ~21-~21: ‘made out of’ might be wordy. Consider a shorter alternative.
Context: ...ery workflow is a definition of a flow, made out of Ballerine's different modules. Whenever...

(EN_WORDINESS_PREMIUM_MADE_OUT_OF)

Whenever a risk flow ("Customer Onboarding" for example) starts, the workflow that is assigned to that risk flow initiates and controls which module should be in use and when.

**Learn more about workflows**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use heading instead of emphasis.

Emphasis is used instead of a heading. Consider using a proper heading.

- **Learn more about workflows**
+ ### Learn more about workflows
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
**Learn more about workflows**
### Learn more about workflows
Tools
Markdownlint

24-24: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

Comment on lines +22 to +27
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix wordiness and use heading instead of emphasis.

The phrase "made out of" is wordy. Consider using "composed of" instead. Also, emphasis is used instead of a heading.

- made out of Ballerine's different modules.
+ composed of Ballerine's different modules.
- **Learn more about workflows**
+ ### Learn more about workflows
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## Workflows
A workflow is the engine that orchestrates the different steps of a risk flow, and how they should interact with each other.
Every workflow is a definition of a flow, made out of Ballerine's different modules.
Whenever a risk flow ("Customer Onboarding" for example) starts, the workflow that is assigned to that risk flow initiates and controls which module should be in use and when.
**Learn more about workflows**
## Workflows
A workflow is the engine that orchestrates the different steps of a risk flow, and how they should interact with each other.
Every workflow is a definition of a flow, composed of Ballerine's different modules.
Whenever a risk flow ("Customer Onboarding" for example) starts, the workflow that is assigned to that risk flow initiates and controls which module should be in use and when.
### Learn more about workflows
Tools
LanguageTool

[style] ~24-~24: ‘made out of’ might be wordy. Consider a shorter alternative.
Context: ...ery workflow is a definition of a flow, made out of Ballerine's different modules. Whenever...

(EN_WORDINESS_PREMIUM_MADE_OUT_OF)

Markdownlint

27-27: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


[Understanding workflows technology](websites/docs/src/content/docs/en/learn/workflows_technology.md)

[Creating a workflow](websites/docs/src/content/docs/en/learn/creating_a_workflow.md)

[Configuring workflow steps](websites/docs/src/content/docs/en/learn/configuring_workflow_steps.md)


## Collection Flows
Ballerine's collection flow module enables you to collect information and documents from you end users, using customizable, white-label digital forms.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix grammatical error.

"you end users" should be "your end users".

- collect information and documents from you end users, using customizable, white-label digital forms.
+ collect information and documents from your end users, using customizable, white-label digital forms.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Ballerine's collection flow module enables you to collect information and documents from you end users, using customizable, white-label digital forms.
Ballerine's collection flow module enables you to collect information and documents from your end users, using customizable, white-label digital forms.
Tools
LanguageTool

[style] ~42-~42: Consider removing “of” to be more concise
Context: ...ustomizable, white-label digital forms. All of the steps and inputs are fully customizable...

(ALL_OF_THE)

All of the steps and inputs are fully customizable, to enable building different types of flows.

**Learn more about collection flows**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use heading instead of emphasis.

Emphasis is used instead of a heading. Consider using a proper heading.

- **Learn more about collection flows**
+ ### Learn more about collection flows
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
**Learn more about collection flows**
### Learn more about collection flows
Tools
Markdownlint

39-39: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


Comment on lines +38 to +43
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix grammatical error and use heading instead of emphasis.

"you end users" should be "your end users". Also, emphasis is used instead of a heading.

- collect information and documents from you end users, using customizable, white-label digital forms.
+ collect information and documents from your end users, using customizable, white-label digital forms.
- **Learn more about collection flows**
+ ### Learn more about collection flows
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## Collection Flows
Ballerine's collection flow module enables you to collect information and documents from you end users, using customizable, white-label digital forms.
All of the steps and inputs are fully customizable, to enable building different types of flows.
**Learn more about collection flows**
## Collection Flows
Ballerine's collection flow module enables you to collect information and documents from your end users, using customizable, white-label digital forms.
All of the steps and inputs are fully customizable, to enable building different types of flows.
### Learn more about collection flows
Tools
LanguageTool

[uncategorized] ~39-~39: “you” seems less likely than “your” (belonging to you).
Context: ... collect information and documents from you end users, using customizable, white-la...

(AI_HYDRA_LEO_CP_YOU_YOUR)


[style] ~39-~39: Consider removing “of” to be more concise
Context: ...ustomizable, white-label digital forms. All of the steps and inputs are fully customizable...

(ALL_OF_THE)

Markdownlint

42-42: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

[Creating a collection flow](websites/docs/src/content/docs/en/learn/creating_a_collection_flow)

[Configuring a collection flow](websites/docs/src/content/docs/en/learn/configuring_a_collection_flow.md)

[Changing the collection flow design](websites/docs/src/content/docs/en/learn/changing the_collection_flow_design.md)


<img title="Collection Flow" alt="Collection Flow" src="https://uploads-ssl.webflow.com/62a3bad46800eb4715b2faf1/669eacfd54f5c71e9c9edb85_Collection%20flow%20example.png">




## Rules Engine
The Rules Engine applies risk rules to assign risk scores, present risk indicators, and automate decisions within workflows. It encompasses transition rules, risk calculation, and alerting mechanisms.

**Learn more about the rule engine**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use heading instead of emphasis.

Emphasis is used instead of a heading. Consider using a proper heading.

- **Learn more about the rule engine**
+ ### Learn more about the rule engine
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
**Learn more about the rule engine**
### Learn more about the rule engine
Tools
Markdownlint

56-56: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

Comment on lines +54 to +57
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use heading instead of emphasis.

Emphasis is used instead of a heading. Consider using a proper heading.

- **Learn more about the rule engine**
+ ### Learn more about the rule engine
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## Rules Engine
The Rules Engine applies risk rules to assign risk scores, present risk indicators, and automate decisions within workflows. It encompasses transition rules, risk calculation, and alerting mechanisms.
**Learn more about the rule engine**
## Rules Engine
The Rules Engine applies risk rules to assign risk scores, present risk indicators, and automate decisions within workflows. It encompasses transition rules, risk calculation, and alerting mechanisms.
### Learn more about the rule engine
Tools
Markdownlint

57-57: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


[Adding rules step to the workflow](websites/docs/src/content/docs/en/learn/adding rules_step_to_the_workflow.md)

[Adding/configuring a rule](websites/docs/src/content/docs/en/learn/adding_or_configuring_a_rule.md)

[Making a rule affect a workflow state](websites/docs/src/content/docs/en/learn/making_a_rule_affect_a_workflow_state.md)

## Case Managment
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix typo in heading.

"Managment" should be "Management".

- ## Case Managment
+ ## Case Management
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## Case Managment
## Case Management

The Case Management module provides a user interface for manual decision-making processes, such as approving, rejecting, or requesting re-submission of cases. It offers customizable layouts and information presentation, allowing users to efficiently handle and review cases.

**Learn more about case management**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use heading instead of emphasis.

Emphasis is used instead of a heading. Consider using a proper heading.

- **Learn more about case management**
+ ### Learn more about case management
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
**Learn more about case management**
### Learn more about case management
Tools
Markdownlint

64-64: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

Comment on lines +63 to +66
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix typo in heading and use heading instead of emphasis.

"Managment" should be "Management". Also, emphasis is used instead of a heading.

- ## Case Managment
+ ## Case Management
- **Learn more about case management**
+ ### Learn more about case management
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## Case Managment
The Case Management module provides a user interface for manual decision-making processes, such as approving, rejecting, or requesting re-submission of cases. It offers customizable layouts and information presentation, allowing users to efficiently handle and review cases.
**Learn more about case management**
## Case Management
The Case Management module provides a user interface for manual decision-making processes, such as approving, rejecting, or requesting re-submission of cases. It offers customizable layouts and information presentation, allowing users to efficiently handle and review cases.
### Learn more about case management
Tools
Markdownlint

66-66: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


[Overview of case management](websites/docs/src/content/docs/en/learn/overview_of_case_management.md)

[Using the case management dashboard](websites/docs/src/content/docs/en/learn/using_the_case_management_dashboard.md)

[Customizing case management workflows](websites/docs/src/content/docs/en/learn/customizing_case_management_workflows.md)


<img title="Case Management" alt="Case Management" src="https://uploads-ssl.webflow.com/62a3bad46800eb4715b2faf1/669eb373c7708310d2b4ac61_Case%20managment%20example.png">

## Unified API

Ballerine's unified API is integrated with third-party vendors, APIs, and data sources to enhance functionality and capabilities.

**Learn more about the unified API**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use heading instead of emphasis.

Emphasis is used instead of a heading. Consider using a proper heading.

- **Learn more about the unified API**
+ ### Learn more about the unified API
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
**Learn more about the unified API**
### Learn more about the unified API
Tools
Markdownlint

79-79: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


[Adding a 3rd Party check to a workflow]()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix empty link.

Empty link should be populated with the correct URL or removed.

- [Adding a 3rd Party check to a workflow]()
+ [Adding a 3rd Party check to a workflow](URL)
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
[Adding a 3rd Party check to a workflow]()
[Adding a 3rd Party check to a workflow](URL)
Tools
Markdownlint

88-88: null
No empty links

(MD042, no-empty-links)


## Child Workflows
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix duplicated phrase.

"Child Workflows" is repeated. Use it only once.

- ## Child Workflows
- Child workflows allow for the generation and activation of extra side workflows (for example: generating multiple KYC flows for the UBOs provided mid-flow, or an extra KYB process for a parent company) and enable complex, nested processes within the main workflows.
+ ## Child Workflows
+ Child workflows allow for the generation and activation of extra side workflows (for example: generating multiple KYC flows for the UBOs provided mid-flow, or an extra KYB process for a parent company) and enable complex, nested processes within the main workflows.

Committable suggestion was skipped due to low confidence.

Tools
LanguageTool

[grammar] ~84-~84: This phrase is duplicated. You should probably use “Child Workflows” only once.
Context: ...a 3rd Party check to a workflow]() ## Child Workflows Child workflows allow for the generation and activation...

(PHRASE_REPETITION)

Child workflows allow for the generation and activation of extra side workflows (for example: generating multiple KYC flows for the UBOs provided mid-flow, or an extra KYB process for a parent company) and enable complex, nested processes within the main workflows.

**Learn more about child workflows**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use heading instead of emphasis.

Emphasis is used instead of a heading. Consider using a proper heading.

- **Learn more about child workflows**
+ ### Learn more about child workflows
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
**Learn more about child workflows**
### Learn more about child workflows
Tools
Markdownlint

86-86: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


[Adding a child workflow to your workflow](websites/docs/src/content/docs/en/learn/adding_a_3rd_party_check_to_a_workflow.md)

## Plugins

Ballerine's plugins enables deep integration with your existing systems, allowing for functionalities such as triggering flows through your CRM, integrating with pre-existing vendors, and displaying their information within Ballerine's platform.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix grammatical error.

"Ballerine's plugins enables deep integration" should be "Ballerine's plugins enable deep integration".

- Ballerine's plugins enables deep integration with your existing systems, allowing for functionalities such as triggering flows through your CRM, integrating with pre-existing vendors, and displaying their information within Ballerine's platform.
+ Ballerine's plugins enable deep integration with your existing systems, allowing for functionalities such as triggering flows through your CRM, integrating with pre-existing vendors, and displaying their information within Ballerine's platform.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Ballerine's plugins enables deep integration with your existing systems, allowing for functionalities such as triggering flows through your CRM, integrating with pre-existing vendors, and displaying their information within Ballerine's platform.
Ballerine's plugins enable deep integration with your existing systems, allowing for functionalities such as triggering flows through your CRM, integrating with pre-existing vendors, and displaying their information within Ballerine's platform.


**Learn more about plugins**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use heading instead of emphasis.

Emphasis is used instead of a heading. Consider using a proper heading.

- **Learn more about plugins**
+ ### Learn more about plugins
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
**Learn more about plugins**
### Learn more about plugins
Tools
Markdownlint

94-94: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


[Adding a plugin to your workflow](websites/docs/src/content/docs/en/learn/adding_a_plugin_to_your_workflow.md)


## Webhooks
Webhooks in Ballerine allow for real-time communication and integration with external systems. They enable the system to send automated messages or information to other systems as events occur within Ballerine.

**Learn more about webhooks**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use heading instead of emphasis.

Emphasis is used instead of a heading. Consider using a proper heading.

- **Learn more about webhooks**
+ ### Learn more about webhooks
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
**Learn more about webhooks**
### Learn more about webhooks
Tools
Markdownlint

102-102: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


[How to use webhooks](websites/docs/src/content/docs/en/learn/how_to_use_webhooks.md)

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Adding rules step to the workflow
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Adding a 3rd Party check to a workflow
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Adding a child workflow to your workflow
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Adding a plugin to your workflow
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Adding/configuring a rule
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Changing the collection flow design
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Configuring a collection flow
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Configuring workflow steps
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Creating a collection flow
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Creating a workflow

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Customizing case management workflows
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# How to use webhooks
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Making a rule affect a workflow state
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Overview of case management
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Using the case management dashboard
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Understanding workflows technology

Workflows in our system are built on top of state machines, specifically using the [XState library](https://xstate.js.org/docs/). These workflows orchestrate flows within the system, both on the backend and frontend. They are designed with an integrated plugin system, customizable templates, and durable executions.

### Why state machines?

In our system, workflows are defined using a State Machine model, specifically statecharts, which is implemented using the [XState library](https://xstate.js.org/docs/). In the realm of state machines, a system can be in only one state at a time. From that state, certain actions or events can lead the system to transition to other states.

Statecharts allow the definition of complex behavior using states, sub-states, and transitions between states. It's a robust way to manage and visualize the different stages of a process and the conditions that lead to state changes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix the misspelling of "sub-states".

The word "sub-states" should be spelled as one word.

- Statecharts allow the definition of complex behavior using states, sub-states, and transitions between states. It's a robust way to manage and visualize the different stages of a process and the conditions that lead to state changes.
+ Statecharts allow the definition of complex behavior using states, substates, and transitions between states. It's a robust way to manage and visualize the different stages of a process and the conditions that lead to state changes.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Statecharts allow the definition of complex behavior using states, sub-states, and transitions between states. It's a robust way to manage and visualize the different stages of a process and the conditions that lead to state changes.
Statecharts allow the definition of complex behavior using states, substates, and transitions between states. It's a robust way to manage and visualize the different stages of a process and the conditions that lead to state changes.
Tools
LanguageTool

[misspelling] ~12-~12: This word is normally spelled as one.
Context: ...ition of complex behavior using states, sub-states, and transitions between states. It's a...

(EN_COMPOUNDS_SUB_STATES)