index.rst

.. only:: not html
   .. note::
      If you are viewing this on GitHub, you probably won't have a pleasant experience as it contains MyST Markdown
      to allow us to generate rich navigation. Instead, please navigate to our published user guide:
      https://snapchat.github.io/GiGL/docs/user_guide.
      Alternatively, our full documentation is available at:
      https://snapchat.github.io/GiGL

User Guide

Welcome to the GiGL User Guide. This guide provides detailed documentation to help you effectively use the library.

.. toctree::
   :maxdepth: 1
   :caption: Overview

   overview/what_is_gigl
   overview/architecture

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   getting_started/quick_start
   getting_started/cloud_setup_guide
   getting_started/installation
   getting_started/orchestration
   examples/index

.. toctree::
   :maxdepth: 1
   :caption: Config Guides

   config_guides/resource_config_guide
   config_guides/task_config_guide
   config_guides/data_preprocessor_spec_guide

.. toctree::
   :maxdepth: 1
   :caption: Public Resources

   public_resources/docker_images
   public_resources/public_data

.. toctree::
   :maxdepth: 1
   :caption: Trouble Shooting

   trouble_shooting/faq