======================
Weaver — Documentation
======================

Welcome to the official documentation of **Weaver**.

This documentation provides information for both **end users** and **developers**:

- End users will learn how to install, configure, and use the program.
- Developers will find detailed information about the internal architecture, build system, and contribution process.

----

.. contents::
   :local:
   :depth: 1
   :backlinks: none

----

Getting Started
===============

If you are new to the project, start here:

- :doc:`user_guide/installation`
- :doc:`user_guide/usage`
- :doc:`user_guide/examples`

For developers, visit the :doc:`developer_guide/build_system` section.

----

Documentation Structure
=======================

.. toctree::
   :maxdepth: 2
   :caption: 📘 User Guide

   user_guide/installation
   user_guide/configuration
   user_guide/usage
   user_guide/examples
   user_guide/troubleshooting

.. toctree::
   :maxdepth: 2
   :caption: 🧠 Developer Guide

   developer_guide/build_system
   developer_guide/adding_features
   developer_guide/contribution
   developer_guide/code_style
   developer_guide/json_validator

.. toctree::
   :maxdepth: 1
   :caption: ⚙️ Reference

   reference/api

.. toctree::
   :maxdepth: 2
   :caption: 🧪 Testing and Deployment

   testing/overview
   testing/unit_tests
   testing/ci_cd

----

Additional Resources
====================

- 🏠 `Project Repository`_
- 🧩 `API Reference <api/html/index.html>`_
- 💬 `Report Issues`_