.. _user-manual:

===========
User Manual
===========

.. toctree::
   :maxdepth: 2
   :hidden:

   getting-started/index
   walkthrough/index
   configuration/index
   troubleshooting/index
   tuning/index
   services/index

.. panel-box::
  :title: Overview
  :id: "getting-started"
  :class: my-panel

  EmbassyOS is designed to work out of the box with a minimal setup and immediate practicality.  That said, there are many use-cases and utilities that can be added and tweaked at your convenience, which are covered extensively in this manual.  You can get started right away with :ref:`Initial Setup <initial-setup>`, head to our :doc:`Walkthrough <walkthrough/index>` for a guided tour, or learn about :doc:`Services <services/index>` and how to use them.  In the :doc:`Configuration <configuration/index>` and :doc:`Tuning <tuning/index>` chapters, you can put your Embassy to work, and make it unique.  Finally, you can cure common hiccups with :doc:`Troubleshooting <troubleshooting/index>`.

  For further information, check out :ref:`Knowledge Base <knowledge-base>` to learn about the technologies behind Embassy, including Frequently Asked Questions.  When you're ready to build, please check out our :ref:`Developer Docs <dev-docs>`.  Please don't hestitate to :ref:`Contact Us <contact>` if you have any issues, questions, or suggestions.

  * :doc:`Getting Started <getting-started/index>` - Initial setup and device-specific guides to connect with your Embassy.
  * :doc:`Walkthrough <walkthrough/index>` - A guided tour of EmbassyOS.
  * :doc:`Services <services/index>` - Overview of featured Services and general usage on EmbassyOS.
  * :doc:`Configuration Options <configuration/index>` - Configuration your Embassy.
  * :doc:`Tuning <tuning/index>` - Customize your Embassy with advanced configuration and external service integrations.
  * :doc:`Troubleshooting <troubleshooting/index>` - Resolve any common issues you may encounter.