Fill in the technical documentation

[vikman90]

Description

We need to complete the technical documentation of the project following the Diátaxis framework. This includes development documentation and a comprehensive reference manual.

Expected documentation

dev/ (Development documentation)

• Setting up the development environment
  • Setting up the toolchain
  • Setting up the editor/debugger
• How to generate a package
• How to generate a container image
• How to build from sources
  • Build scripts/Makefiles
• How to run the product from source for testing/development
• How to run the tests

ref/ (Reference manual)

• Introduction
  • Description
  • Architecture
  • Compatibility
• Getting started
  • Requirements
  • Packages
  • Installation
• Configuration
  • Environment variables
  • Command line options
  • Configuration files
• Modules (for each module)
  • Description
  • Architecture
  • API reference
• Upgrade
• Uninstall
• Back up and restore
• Security
• Performance
• Glossary

Definition of Done

• All documentation points are written
• The documentation follows the Diátaxis framework
• The structure is consistent and clear

Additional Notes

• Ensure technical accuracy and completeness
• Maintain a professional and concise writing style
• Use Markdown formatting for clarity

[sdvendramini]

2025/02/17

I started working on the issue by studying Diátaxis. Then, I reviewed the existing documentation and began reorganizing it.