From b909e51e4d63ca5f89b93bdde108186e20719c49 Mon Sep 17 00:00:00 2001
From: eslam-gomaa <eslam.sa3dany2015@gmail.com>
Date: Sun, 30 Jun 2024 15:25:28 +0300
Subject: [PATCH] refactor KPtop docs

---
 docs/commands/index.md   | 69 ++++++++++++++++++++++++++++++++++++++++
 docs/dashboards/index.md | 69 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 138 insertions(+)
 create mode 100644 docs/commands/index.md
 create mode 100644 docs/dashboards/index.md

diff --git a/docs/commands/index.md b/docs/commands/index.md
new file mode 100644
index 0000000..05f0339
--- /dev/null
+++ b/docs/commands/index.md
@@ -0,0 +1,69 @@
+---
+layout: default
+nav_order: 2
+# permalink: /
+# parent: Home
+permalink: /commands
+title: Custom Commands Docs
+markdown: Kramdown
+has_children: true
+kramdown:
+  parse_block_html: true
+  auto_ids: true
+  syntax_highlighter: coderay
+---
+
+<button class="btn js-toggle-dark-mode">Switch to Dark Mode
+
+<script>
+const toggleDarkMode = document.querySelector('.js-toggle-dark-mode');
+
+jtd.addEvent(toggleDarkMode, 'click', function(){
+  if (jtd.getTheme() === 'dark') {
+    jtd.setTheme('light');
+    toggleDarkMode.textContent = 'Switch to Dark Mode';
+  } else {
+    jtd.setTheme('dark');
+    toggleDarkMode.textContent = 'Switch to Light Mode';
+  }
+});
+</script>
+
+# Custom Commands
+{: .fs-9 }
+
+Create monitoring dasboards on the terminal easily with a simple yaml file !
+
+<br>
+
+## Examples
+- [pods.yml](../../examples/dashboards/pods.yml)
+- [pvcs.yml](../../examples/dashboards/pvcs.yml)
+
+<br>
+
+---
+
+<br>
+
+## List commands
+
+```bash
+kptop --list-commands
+```
+
+
+## Run command
+
+
+```bash
+kptop --command <DASHBOARD-NAME>
+```
+
+<br>
+
+---
+
+## Command YAMl structure
+
+To be added.
diff --git a/docs/dashboards/index.md b/docs/dashboards/index.md
new file mode 100644
index 0000000..5b8a347
--- /dev/null
+++ b/docs/dashboards/index.md
@@ -0,0 +1,69 @@
+---
+layout: default
+nav_order: 1
+# permalink: /
+# parent: Home
+permalink: /dashboards
+title: Custom Dashboards Docs
+markdown: Kramdown
+has_children: true
+kramdown:
+  parse_block_html: true
+  auto_ids: true
+  syntax_highlighter: coderay
+---
+
+<button class="btn js-toggle-dark-mode">Switch to Dark Mode
+
+<script>
+const toggleDarkMode = document.querySelector('.js-toggle-dark-mode');
+
+jtd.addEvent(toggleDarkMode, 'click', function(){
+  if (jtd.getTheme() === 'dark') {
+    jtd.setTheme('light');
+    toggleDarkMode.textContent = 'Switch to Dark Mode';
+  } else {
+    jtd.setTheme('dark');
+    toggleDarkMode.textContent = 'Switch to Light Mode';
+  }
+});
+</script>
+
+# Custom Dashboards
+{: .fs-9 }
+
+Create monitoring dasboards on the terminal easily with a simple yaml file !
+
+<br>
+
+## Examples
+- [pods.yml](../../examples/dashboards/pods.yml)
+- [pvcs.yml](../../examples/dashboards/pvcs.yml)
+
+<br>
+
+---
+
+<br>
+
+## List dashboards
+
+```bash
+kptop --list-dashboards
+```
+
+
+## Run dashboard
+
+
+```bash
+kptop --dashboard <DASHBOARD-NAME>
+```
+
+<br>
+
+---
+
+## Dashboard YAMl structure
+
+To be added.