ns-3 Continuum Documentation
============================


|lastupdated| |github| |release|

.. |lastupdated| image:: https://img.shields.io/github/last-commit/MullanJohn/ns3-distributed

.. |github| image:: https://img.shields.io/badge/GitHub-ns3--continuum-181717?logo=github&style=flat-square
            :target: https://github.com/MullanJohn/ns3-distributed

.. |release| image:: https://img.shields.io/github/v/release/MullanJohn/ns3-distributed

Welcome to the documentation for ns-3 Continuum. A flexible module for simulating
workloads that travel over the computing continuum in ns-3. If you are new to this
documentation, we recommend that you read the :ref:`introduction page <doc_about_intro>` to get an overview
of what this documentation has to offer.


.. note:: This documentation is part of an open source project produced as part of a final year project at UCC.

          You can submit an issue or pull request on the `GitHub repository
          <https://github.com/MullanJohn/ns3-distributed/issues>`_.


The main documentation is organised into the following sections:

.. toctree::
   :maxdepth: 2
   :caption: General

   about/introduction.rst

.. toctree::
   :maxdepth: 1
   :caption: API Documentation

   api/tasks
   api/accelerators
   api/orchestration
   api/device-management
   api/transport
   api/applications
   api/protocol-headers