Skip to content

Commit 1fd4380

Browse files
Merge branch 'readme' into feature/ebpf-core
2 parents 82f8b48 + a15f951 commit 1fd4380

File tree

6 files changed

+111
-135
lines changed

6 files changed

+111
-135
lines changed

Doc/docs/cfcli/overview.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The tool is called **`cfcli`**.
77
This document describes the available commands and provides a quick reference table.
88

99

10-
## 📦 Setup Commands
10+
## Setup Commands
1111

1212
- **`cfcli install cortexflow`**
1313
Installs **all** CortexBrain core components.
@@ -19,7 +19,7 @@ This document describes the available commands and provides a quick reference ta
1919
Uninstalls **all** CortexBrain components.
2020

2121

22-
## ⚙️ CLI Management Commands
22+
## CLI Management Commands
2323

2424
- **`cfcli update`**
2525
Checks if the current `cfcli` version is up to date.
@@ -32,13 +32,13 @@ This document describes the available commands and provides a quick reference ta
3232
- installation environment (Kubernetes, Docker, etc.)
3333

3434

35-
## 📝 Logging Commands
35+
## Logging Commands
3636

3737
- **`cfcli logs`**
3838
Retrieves logs for a specified pod.
3939

4040

41-
## 📊 Monitoring and Status Commands
41+
## Monitoring and Status Commands
4242

4343
- **`cfcli status`**
4444
Performs a health check of the CortexBrain core:
@@ -56,7 +56,7 @@ This document describes the available commands and provides a quick reference ta
5656
- Shows the most recent detected events.
5757

5858

59-
## 📑 Command Reference Table
59+
## Command Reference Table
6060

6161
| Command | Category | Description |
6262
|--------------------------------|----------------------|-----------------------------------------------------------------------------|
@@ -69,5 +69,3 @@ This document describes the available commands and provides a quick reference ta
6969
| `cfcli status` | Monitoring / Status | Runs a health check and validates the `cortexflow` namespace |
7070
| `cfcli monitoring list` | Monitoring / Status | Lists CortexFlow agent endpoints |
7171
| `cfcli monitoring connections` | Monitoring / Status | Displays logged connections from the Identity service |
72-
73-
---

Doc/docs/cfcli/quick-start-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Since CortexFlow works in both environments, you can choose which one suits you
1616

1717
Then you can create a cluster with Calico CNI using the command:
1818
```bash
19-
minikube start --cni=calico
19+
minikube start --cni=calico
2020
```
2121
You can **verify** the Calico installation using this command:
2222
```bash

Doc/docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
!!! note
22
CortexBrain is currently in active development so that occasional bugs may occur. Your contributions and feedback are foundamental for refining and enhancing the project! 🚀
33

4-
**CortexBrain** is an ambitious open-source project aimed at creating an intelligent, lightweight, and efficient architecture to seamlessly connect cloud and edge devices.
4+
**CortexBrain** is an ambitious open-source project designed to build an intelligent, lightweight, and highly efficient monitoring platform for distributed cloud and hybrid (cloud–edge) workflows.
55
## **Current Development Stage**
66

77
You can see the development stage of every component here:

Doc/docs/stylesheets/style.css

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
html {
2+
width: 100%;
3+
}
14
.md-content {
25
width: 800px;
36
margin: auto auto;
@@ -17,6 +20,29 @@
1720
margin-bottom: 30px;
1821
}
1922

23+
.md-typeset p,ul {
24+
font-size: 15px;
25+
line-height: 2;
26+
}
27+
28+
[data-md-color-scheme="slate"]{
29+
--md-default-fg-color: white;
30+
}
31+
[data-md-color-scheme="slate"] strong {
32+
color: #00BCFF;
33+
}
34+
35+
[data-md-color-scheme="slate"] code {
36+
color: #00BCFF;
37+
}
38+
[data-md-color-scheme="default"] code {
39+
color: #00BCFF;
40+
}
41+
42+
[data-md-color-scheme="slate"]{
43+
--md-default-bg-color : #030712;
44+
}
45+
2046
[data-md-color-scheme="slate"] .md-typeset h1 {
2147
font-weight: 800;
2248
color: #7D88EC;
@@ -32,21 +58,29 @@
3258
}
3359

3460
[data-md-color-scheme="slate"] .md-header {
35-
background-color: #1C1C1C;
61+
background-color: #030712;
3662
}
3763

3864
[data-md-color-scheme="slate"] .md-main {
39-
background-color: #1C1C1C;
65+
background-color: #030712;
4066
}
4167

4268
[data-md-color-scheme="slate"] .md-tabs {
43-
background-color: #1C1C1C;
69+
background-color: #030712;
70+
}
71+
72+
[data-md-color-scheme="slate"] .md-sidebar md-sidebar--primary {
73+
background-color: #030712;
4474
}
4575

4676
[data-md-color-scheme="slate"] .md-typeset h4 {
4777
font-weight: 800;
4878
color: #7D88EC;
4979
}
80+
[data-md-color-scheme="slate"] .md-footer-meta{
81+
background-color: #030712;
82+
}
83+
5084

5185
.md-search__form {
5286
border-radius: 30px;

Doc/mkdocs.yml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ repo_url: "https://github.com/CortexFlow/CortexBrain"
1010
theme:
1111
language: en
1212
name: material
13+
icon:
14+
repo: fontawesome/brands/github
1315
font:
1416
text: Lato
1517
logo : ./assets/logo512.png
@@ -19,13 +21,13 @@ theme:
1921
primary: "#7D88EC" #light mode
2022
accent: "#FF5733"
2123
toggle:
22-
icon: material/weather-night
24+
icon: material/brightness-3
2325
name: Switch to dark mode
2426
- scheme: slate
25-
primary: "#121212" # Dark mode
26-
accent: "#FF5733"
27+
primary: "#030712" # Dark mode
28+
accent: "#030712"
2729
toggle:
28-
icon: material/weather-sunny
30+
icon: material/brightness-5
2931
name: Switch to light mode
3032

3133
markdown_extensions:

0 commit comments

Comments
 (0)