Skip to content

Commit 75a3fa5

Browse files
committed
add: concept chart added
1 parent ee5f723 commit 75a3fa5

File tree

4 files changed

+43
-21
lines changed

4 files changed

+43
-21
lines changed
File renamed without changes.

docs/concept.md

Lines changed: 35 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,63 @@
1-
# Necessary Functionality
1+
# Concept
22

3-
## Inputs
3+
## Top Level Concept Chart
4+
5+
```mermaid
6+
graph TD
7+
A[Data Sources] --> B[Combination Layer]
8+
9+
subgraph Inputs
10+
A
11+
end
12+
13+
subgraph Transformation & Features
14+
C[Filters, Functions, Calculations, Stats]
15+
end
16+
17+
B --> C
18+
19+
subgraph Metrics & Events
20+
D[Metrics and Events]
21+
end
22+
23+
C --> D
24+
```
25+
26+
## Target Functionality
27+
28+
### Inputs
429

530
- parquet s3
631
- timescaledb
732
- postgresdb / rest api (signal context)
833
- postgrest (business context)
934

1035

11-
## Combination
36+
### Combination
1237

1338
- timeseries combination with signal context
1439

1540
----- HANDOVER FORMAT: DATAFRAME -----
1641

17-
## Transform
42+
### Transform
1843

1944
- filters - datatype specific filters
2045
- functions - lamda functions (more general)
2146
- time_functions
2247
- calculator
2348

24-
## Features
49+
### Features
2550

2651
- stats - datatype specific stats
2752
- time_stats - timestamp specific stats (last timestamp, first timestamp, occurence per hour, etc.)
2853

29-
----- # -----
30-
31-
## Metrics
32-
33-
-
34-
35-
----- # -----
36-
37-
## Events
54+
### Events
3855

3956
- quality events -
4057
- maintenance events -
4158
- production events -
4259
- engineering events -
60+
61+
### Metrics
62+
63+
- to be defined

docs/summary.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

mkdocs.yml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ nav:
1919
- Changelog: changelog.md
2020
# - Credits: credits.md
2121
- License: license.md
22-
- Summary: summary.md
22+
- Summary: reference/SUMMARY.md
2323
- Usage:
2424
- usage/index.md
2525
# defer to gen-files + literate-nav
@@ -34,7 +34,7 @@ nav:
3434

3535
theme:
3636
name: material
37-
logo: logo.svg
37+
logo: assets/logo.svg
3838
features:
3939
- announce.dismiss
4040
- content.action.edit
@@ -85,7 +85,11 @@ markdown_extensions:
8585
- pymdownx.snippets:
8686
base_path: [!relative $config_dir]
8787
check_paths: true
88-
- pymdownx.superfences
88+
- pymdownx.superfences:
89+
custom_fences:
90+
- name: mermaid
91+
class: mermaid
92+
format: !!python/name:pymdownx.superfences.fence_code_format
8993
- pymdownx.tabbed:
9094
alternate_style: true
9195
slugify: !!python/object/apply:pymdownx.slugs.slugify
@@ -125,7 +129,7 @@ plugins:
125129
parameter_headings: true
126130
separate_signature: true
127131
show_root_heading: true
128-
show_root_full_path: false
132+
show_root_full_path: true
129133
show_signature_annotations: true
130134
show_source: true
131135
show_symbol_type_heading: true

0 commit comments

Comments
 (0)