Skip to content

Commit 5bc3eda

Browse files
docs: add udfs to docs
refactor the advanced docs section
1 parent 06eaee6 commit 5bc3eda

23 files changed

Lines changed: 182 additions & 40 deletions

‎docs/advanced_guidance/package_documentation/auditing.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@
1111
- get_all_business_rule_submissions
1212
- get_all_error_report_submissions
1313
- get_current_processing_info
14+
show_root_toc_entry: false
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Business Rules Documentation
3+
---
4+
5+
<div class="grid cards" markdown>
6+
7+
- :material-language-python:{ .lg .middle } __Operations__
8+
9+
---
10+
11+
[:octicons-arrow-right-24: Read about the `Operation` objects here](operations.md)
12+
13+
- :material-language-python:{ .lg .middle } __Reference Data Loaders__
14+
15+
---
16+
17+
[:octicons-arrow-right-24: Read about the `Business Rules` objects here](refdata_loaders.md)
18+
19+
- :material-language-python:{ .lg .middle } __Reference Data Types__
20+
21+
---
22+
23+
[:octicons-arrow-right-24: Read about the `Data Contract` objects here](reference_data_types.md)
24+
25+
- :material-language-python:{ .lg .middle } __User Defined Functions (UDFs)__
26+
27+
---
28+
29+
[:octicons-arrow-right-24: Read about the `Submission Feedback` objects here](udfs.md)
30+
31+
</div>

docs/advanced_guidance/package_documentation/operations.md renamed to docs/advanced_guidance/package_documentation/business_rules/operations.md

File renamed without changes.

docs/advanced_guidance/package_documentation/refdata_loaders.md renamed to docs/advanced_guidance/package_documentation/business_rules/refdata_loaders.md

File renamed without changes.

docs/advanced_guidance/package_documentation/refence_data_types.md renamed to docs/advanced_guidance/package_documentation/business_rules/reference_data_types.md

File renamed without changes.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
2+
!!! warning
3+
4+
Consider limiting how many UDFs you utilise in your rules as they can cause significant performance degredation when used on large datasets.
5+
6+
::: dve.core_engine.functions.implementations
7+
handler: python
8+
options:
9+
show_root_heading: true
10+
heading_level: 1

docs/advanced_guidance/package_documentation/domain_types.md renamed to docs/advanced_guidance/package_documentation/data_contract/domain_types.md

File renamed without changes.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Data Contract Documentation
3+
---
4+
5+
<div class="grid cards" markdown>
6+
7+
- :material-language-python:{ .lg .middle } __Readers__
8+
9+
---
10+
11+
[:octicons-arrow-right-24: Read about the `Operation` objects here](readers.md)
12+
13+
- :material-language-python:{ .lg .middle } __Domain Types__
14+
15+
---
16+
17+
[:octicons-arrow-right-24: Read about the `Business Rules` objects here](domain_types.md)
18+
19+
20+
</div>

docs/advanced_guidance/package_documentation/readers.md renamed to docs/advanced_guidance/package_documentation/data_contract/readers.md

File renamed without changes.

‎docs/advanced_guidance/package_documentation/entity_hierarchy.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
handler: python
33
options:
44
show_root_heading: true
5-
heading_level: 2
5+
heading_level: 1

0 commit comments

Comments
 (0)