.. LLM-Navigation documentation master file, created by
   sphinx-quickstart on Fri Sep 20 16:55:29 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

LLM-Navigation documentation
============================

Navigate the environment using the 3D Scene Graph and LLM.

Links
-----

* `Hackster.io Project <https://www.hackster.io/519753/navigator-robo-guide-for-your-room-daff65>`_
* `GitHub repository <https://github.com/YuZhong-Chen/LLM-Navigation>`_

.. toctree::
   :caption: Introduction
   :maxdepth: 2
   :numbered:

   introduction/introduction
   introduction/architecture
   introduction/ros2
   introduction/quick_start

.. toctree::
   :caption: Installation
   :maxdepth: 2
   :numbered:

   installation/docker
   installation/devcontainer   
   installation/ros2

.. toctree::
   :caption: CodeBase
   :maxdepth: 2
   :numbered:

   codebase/codebase_overview
   codebase/cartographer_ws
   codebase/gazebo_world_ws
   codebase/hydra_ws
   codebase/kobuki_ws
   codebase/llm_query_ws
   codebase/realsense_ws
   codebase/ros1_bridge_ws
   codebase/vlplidar_ws

.. toctree::
   :caption: Demo
   :maxdepth: 2
   :numbered:

   demo/demo

If you have any questions, please contact the author by email: ``yuzhong1214@gmail.com``, or create an issue on the `GitHub repository <https://github.com/YuZhong-Chen/LLM-Navigation>`_.