.. _user_guide_index:

==========
User Guide
==========

Explore Flowkit's core features: how to register functions, manage input/output, invoke commands, and connect to the Agent.

----

.. grid:: 3
   :gutter: 2

   .. grid-item-card:: :material-regular:`auto_awesome;32px` Overview
      :link: overview
      :link-type: doc
      :class-card: sd-shadow-sm sd-rounded-md
      :text-align: center

      High-level overview of how Flowkit fits into the AALI system.

   .. grid-item-card:: :material-regular:`extension;32px` Function Registration
      :link: function_registration
      :link-type: doc
      :class-card: sd-shadow-sm sd-rounded-md
      :text-align: center

      Register and expose functions with metadata.

   .. grid-item-card:: :material-regular:`memory;32px` Execution Context
      :link: memory
      :link-type: doc
      :class-card: sd-shadow-sm sd-rounded-md
      :text-align: center

      Manage input, output, and runtime values.

.. grid:: 2
   :gutter: 2
   :margin: 2 0 0 0

   .. grid-item-card:: :material-regular:`play_arrow;32px` Calling Functions
      :link: calling
      :link-type: doc
      :class-card: sd-shadow-sm sd-rounded-md
      :text-align: center

      Invoke functions with RunFunction and StreamFunction.

   .. grid-item-card:: :material-regular:`terminal;32px` Slash Commands
      :link: slash_commands
      :link-type: doc
      :class-card: sd-shadow-sm sd-rounded-md
      :text-align: center

      Use developer commands like `/reset` or `/summary`.

   .. grid-item-card:: :material-regular:`hub;32px` Agent Integration
      :link: agent_integration
      :link-type: doc
      :class-card: sd-shadow-sm sd-rounded-md
      :text-align: center

      Understand how the Agent receives and responds to function calls.

   .. grid-item-card:: :material-regular:`dynamic_form;32px` Exposed Variables
      :link: exposed_variables
      :link-type: doc
      :class-card: sd-shadow-sm sd-rounded-md
      :text-align: center

      Share data across workflow steps using key-value inputs.