wazuh · asteriscos · Feb 19, 2025 · Feb 18, 2025 · Feb 18, 2025 · Feb 18, 2025
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -0,0 +1,41 @@
+name: deploy-gh-pages
+
+# From https://github.com/rust-lang/mdBook/wiki/Automated-Deployment%3A-GitHub-Actions#GitHub-Pages-Deploy
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: write # To push a branch
+      pages: write # To push to a GitHub Pages site
+      id-token: write # To update the deployment status
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup mdBook
+        uses: jontze/action-mdbook@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          use-linkcheck: true
+          use-mermaid: true
+          use-toc: true
+      - run: mdbook build
+        working-directory: docs
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'docs/book'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/README.md b/README.md
@@ -1,20 +1,12 @@
 <p align="center">
     <img width="640px" src="https://wazuh.com/uploads/2022/05/Logo-blogpost.png"/>
 </p>
-<p align="center">
-    <a href="https://wazuh.com/community/join-us-on-slack">
-        <img src="https://img.shields.io/badge/slack-join-blue.svg" />
-    </a>
-    <a href="https://groups.google.com/forum/#!forum/wazuh">
-        <img src="https://img.shields.io/badge/email-join-blue.svg" />
-    </a>
-    <a href="https://documentation.wazuh.com">
-        <img src="https://img.shields.io/badge/docs-view-green.svg" />
-    </a>
-    <a href="https://wazuh.com">
-        <img src="https://img.shields.io/badge/web-view-green.svg" />
-    </a>
-</p>
+
+[![Slack](https://img.shields.io/badge/slack-join-blue.svg)](https://wazuh.com/community/join-us-on-slack/)
+[![Forum](https://img.shields.io/badge/chat-on%20forums-blue)](https://groups.google.com/forum/#!forum/wazuh)
+[![Documentation](https://img.shields.io/badge/docs-view-green.svg)](https://documentation.wazuh.com)
+[![Web](https://img.shields.io/badge/web-view-green.svg)](https://wazuh.com)
+[![GH Pages](https://github.com/wazuh/wazuh-dashboard-plugins/actions/workflows/deploy-docs.yml/badge.svg)](https://github.com/wazuh/wazuh-dashboard-plugins/actions/workflows/deploy-docs.yml)
 
 - [Welcome](#welcome)
 - [Project resources](#project-resources)

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1 @@
+book
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,27 @@
+# Wazuh Agent Technical Documentation
+
+This folder contains the technical documentation for the Wazuh dashboard. The documentation is organized into the following guides:
+
+- **Development Guide**: Instructions for building, testing, and packaging the agent.
+- **Reference Manual**: Detailed information on the agent’s architecture, configuration, and usage.
+- **Diagnostic Guide**: Steps to diagnose errors and resolve common issues.
+
+## Requirements
+
+To work with this documentation, you need **mdBook** installed. For installation instructions, refer to the [mdBook documentation](https://rust-lang.github.io/mdBook/).
+
+## Usage
+
+- To build the documentation, run:
+
+  ```bash
+  ./build.sh
+  ```
+
+  The output will be generated in the `book` directory.
+
+- To serve the documentation locally for preview, run:
+  ```bash
+  ./server.sh
+  ```
+  The documentation will be available at [http://127.0.0.1:3000](http://127.0.0.1:3000).
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -0,0 +1,36 @@
+# Summary
+
+- [Introduction](README.md)
+
+# Development Documentation
+
+- [Introduction](dev/README.md)
+- [Setup Environment](dev/setup.md)
+- [Build Packages](dev/build-packages.md)
+- [Build Image](dev/build-image.md)
+- [Build from Sources](dev/build-sources.md)
+- [Run from Sources](dev/run-sources.md)
+- [Run Tests](dev/run-tests.md)
+
+# Reference Manual
+
+- [Introduction](ref/README.md)
+  - [Description](ref/description.md)
+  - [Architecture](ref/architecture.md)
+  - [Compatibility](ref/compatibility.md)
+- [Getting Started](ref/getting-started/README.md)
+  - [Requirements](ref/getting-started/requirements.md)
+  - [Packages](ref/getting-started/packages.md)
+  - [Installation](ref/getting-started/installation.md)
+- [Configuration](ref/configuration.md)
+- [Modules](ref/modules/README.md)
+- [Upgrade](ref/upgrade.md)
+- [Uninstall](ref/uninstall.md)
+- [Back Up and Restore](ref/backup-restore.md)
+- [Security](ref/security.md)
+- [Performance](ref/performance.md)
+- [Glossary](ref/glossary.md)
+
+# Diagnostic Documentation
+
+- [Diagnostic Guide](diag/diagnostic.md)
diff --git a/docs/book.toml b/docs/book.toml
@@ -0,0 +1,7 @@
+[book]
+title = "Wazuh dashboard documentation"
+authors = ["Wazuh dashboard Team"]
+description = "The technical documentation for the Wazuh dashboard, composed by the development documentation and the reference manual."
+language = "en"
+multilingual = false
+src = "."
diff --git a/docs/build.sh b/docs/build.sh
@@ -0,0 +1,3 @@
+#! /bin/sh
+
+mdbook build
diff --git a/docs/development/README.md → docs/dev/README.md b/docs/development/README.md → docs/dev/README.md
diff --git a/docs/dev/build-image.md b/docs/dev/build-image.md
@@ -0,0 +1 @@
+# How to generate a container image
diff --git a/docs/dev/build-packages.md b/docs/dev/build-packages.md
@@ -0,0 +1 @@
+# How to generate a package
diff --git a/docs/dev/build-sources.md b/docs/dev/build-sources.md
@@ -0,0 +1 @@
+# How to build from sources
diff --git a/docs/dev/run-sources.md b/docs/dev/run-sources.md
@@ -0,0 +1 @@
+# How to run from sources
diff --git a/docs/dev/run-tests.md b/docs/dev/run-tests.md
@@ -0,0 +1 @@
+# How to run the tests
diff --git a/docs/dev/setup.md b/docs/dev/setup.md
@@ -0,0 +1,5 @@
+# Setup the development environment
+
+## Setup the toolchain
+
+## Setup the editor/debugger
diff --git a/docs/diag/diagnostic.md b/docs/diag/diagnostic.md
@@ -0,0 +1 @@
+# Diagnostic Guide
diff --git a/docs/ref/architecture.md b/docs/ref/architecture.md
@@ -0,0 +1 @@
+# Architecture
diff --git a/docs/ref/backup-restore.md b/docs/ref/backup-restore.md
@@ -0,0 +1 @@
+# Backup and restore
diff --git a/docs/ref/compatibility.md b/docs/ref/compatibility.md
@@ -0,0 +1 @@
+# Compatibility
diff --git a/docs/ref/configuration.md b/docs/ref/configuration.md
@@ -0,0 +1 @@
+# Configuration
diff --git a/docs/ref/description.md b/docs/ref/description.md
@@ -0,0 +1 @@
+# Description
diff --git a/docs/ref/getting-started/installation.md b/docs/ref/getting-started/installation.md
@@ -0,0 +1 @@
+# Installation
diff --git a/docs/ref/getting-started/packages.md b/docs/ref/getting-started/packages.md
@@ -0,0 +1 @@
+# Packages
diff --git a/docs/ref/getting-started/requirements.md b/docs/ref/getting-started/requirements.md
@@ -0,0 +1 @@
+# Requirements
diff --git a/docs/ref/glossary.md b/docs/ref/glossary.md
@@ -0,0 +1 @@
+# Glossary
diff --git a/docs/ref/modules/README.md b/docs/ref/modules/README.md
@@ -0,0 +1 @@
+# Modules
diff --git a/docs/ref/performance.md b/docs/ref/performance.md
@@ -0,0 +1 @@
+# Performance
diff --git a/docs/ref/security.md b/docs/ref/security.md
@@ -0,0 +1 @@
+# Security
diff --git a/docs/ref/uninstall.md b/docs/ref/uninstall.md
@@ -0,0 +1 @@
+# Uninstall
diff --git a/docs/ref/upgrade.md b/docs/ref/upgrade.md
@@ -0,0 +1 @@
+# Upgrade
diff --git a/docs/serve.sh b/docs/serve.sh
@@ -0,0 +1,3 @@
+#! /bin/sh
+
+mdbook serve --open