add docs directory to workspace
Taylor committed
Jul 11, 2023 at 13:08 UTC
03853631d20b1edc95ae63ed9f07312993ffad69
8 files changed
+156
.github/workflows/docs/agents.md
new
+15
@@ -0,0 +1,15 @@
1
+## Agents Overview
2
+
3
+### <span style="color:blue">Agent Model</span>
4
+
5
+::: app.models.agents
6
+<br>
7
+
8
+### <span style="color:green">Agent Routes</span>
9
+
10
+::: app.routes.agents
11
+<br>
12
+
13
+### <span style="color:red">Agent Services</span>
14
+
15
+::: app.services.agents.agents
.github/workflows/docs/alerts.md
new
+10
@@ -0,0 +1,10 @@
1
+## Alerts Overview
2
+
3
+### <span style="color:green">Alert Routes</span>
4
+
5
+::: app.routes.alerts
6
+<br>
7
+
8
+### <span style="color:red">Alert Services</span>
9
+
10
+::: app.services.WazuhIndexer.alerts
.github/workflows/docs/artifacts.md
new
+15
@@ -0,0 +1,15 @@
1
+## Artifacts Overview
2
+
3
+### <span style="color:blue">Artifacts Model</span>
4
+
5
+::: app.models.artifacts
6
+<br>
7
+
8
+### <span style="color:green">Artifacts Routes</span>
9
+
10
+::: app.routes.velociraptor
11
+<br>
12
+
13
+### <span style="color:red">Artifacts Services</span>
14
+
15
+::: app.services.Velociraptor.artifacts
.github/workflows/docs/cases.md
new
+15
@@ -0,0 +1,15 @@
1
+## Cases Overview
2
+
3
+### <span style="color:blue">Cases Model</span>
4
+
5
+::: app.models.cases
6
+<br>
7
+
8
+### <span style="color:green">Cases Routes</span>
9
+
10
+::: app.routes.dfir_iris
11
+<br>
12
+
13
+### <span style="color:red">Cases Services</span>
14
+
15
+::: app.services.DFIR_IRIS.cases
.github/workflows/docs/connectors.md
new
+15
@@ -0,0 +1,15 @@
1
+## Connectors Overview
2
+
3
+### <span style="color:blue">Connectors Model</span>
4
+
5
+::: app.models.connectors
6
+<br>
7
+
8
+### <span style="color:green">Connectors Routes</span>
9
+
10
+::: app.routes.connectors
11
+<br>
12
+
13
+### <span style="color:red">Connectors Services</span>
14
+
15
+::: app.services.connectors.connectors
.github/workflows/docs/graylog.md
new
+19
@@ -0,0 +1,19 @@
1
+## Graylog Overview
2
+
3
+### <span style="color:blue">Graylog Model</span>
4
+
5
+::: app.models.graylog
6
+<br>
7
+
8
+### <span style="color:green">Graylog Routes</span>
9
+
10
+::: app.routes.graylog
11
+<br>
12
+
13
+### <span style="color:red">Graylog Services</span>
14
+
15
+::: app.services.Graylog.index
16
+::: app.services.Graylog.inputs
17
+::: app.services.Graylog.messages
18
+::: app.services.Graylog.metrics
19
+::: app.services.Graylog.universal
.github/workflows/docs/index.md
new
+6
@@ -0,0 +1,6 @@
1
+## Project overview
2
+
3
+<!--
4
+::: src.test.agents -->
5
+
6
+::: app.models.agents
.github/workflows/docs/mkdocs.yml
new
+61
@@ -0,0 +1,61 @@
1
+site_name: SOCFortress CoPilot
2
+theme:
3
+ name: material
4
+ features:
5
+ - navigation.tabs
6
+ - navigation.sections
7
+ - toc.integrate
8
+ - navigation.top
9
+ - search.suggest
10
+ - search.highlight
11
+ - content.tabs.link
12
+ - content.code.annotation
13
+ - content.code.copy
14
+
15
+ language: en
16
+ palette:
17
+ - scheme: default
18
+ toggle:
19
+ icon: material/toggle-switch-off-outline
20
+ name: Switch to dark mode
21
+ primary: teal
22
+ accent: purple
23
+ - scheme: slate
24
+ toggle:
25
+ icon: material/toggle-switch
26
+ name: Switch to light mode
27
+ primary: teal
28
+ accent: lime
29
+
30
+plugins:
31
+ - mkdocstrings:
32
+ - autorefs
33
+
34
+nav:
35
+ - Home: index.md
36
+ - Connectors: connectors.md
37
+ - Agents: agents.md
38
+ - Alerts: alerts.md
39
+ - Artifacts: artifacts.md
40
+ - Cases: cases.md
41
+ - Graylog: graylog.md
42
+
43
+markdown_extensions:
44
+ - pymdownx.highlight:
45
+ anchor_linenums: true
46
+ - pymdownx.inlinehilite
47
+ - pymdownx.snippets
48
+ - admonition
49
+ - pymdownx.arithmatex:
50
+ generic: true
51
+ - footnotes
52
+ - pymdownx.details
53
+ - pymdownx.superfences
54
+ - pymdownx.mark
55
+ - attr_list
56
+ - pymdownx.emoji:
57
+ emoji_index: !!python/name:materialx.emoji.twemoji
58
+ emoji_generator: !!python/name:materialx.emoji.to_svg
59
+
60
+copyright: |
61
+ © 2023 <a href="https://github.com/socfortress/CoPilot" target="_blank" rel="noopener">SOCFortress CoPilot</a>