mirror of
https://github.com/wazuh/wazuh-indexer-plugins.git
synced 2025-12-12 14:15:49 -06:00
953000c091
* Intialize technical documentation system * Fix typo * Add ending line to files * Correct a word --------- Co-authored-by: Malena Casas <malena.casas@wazuh.com>
Wazuh Indexer Technical Documentation
This folder contains the technical documentation for the Wazuh Indexer. The documentation is organized into the following guides:
- Development Guide: Instructions for building, testing, and packaging the Indexer.
- Reference Manual: Detailed information on the Indexer’s architecture, configuration, and usage.
Requirements
To work with this documentation, you need mdBook installed. For installation instructions, refer to the mdBook documentation.
Usage
-
To build the documentation, run:
./build.shThe output will be generated in the
bookdirectory. -
To serve the documentation locally for preview, run:
./serve.shThe documentation will be available at http://127.0.0.1:3000.