..
   # *******************************************************************************
   # Copyright (c) 2026 ZF Friedrichshafen AG
   #
   # See the NOTICE file(s) distributed with this work for additional
   # information regarding copyright ownership.
   #
   # This program and the accompanying materials are made available under the
   # terms of the Apache License Version 2.0 which is available at
   # https://www.apache.org/licenses/LICENSE-2.0
   #
   # SPDX-License-Identifier: Apache-2.0
   #
   # Contributors:
   #   Thomas Pfleiderer - documentation
   # *******************************************************************************

Welcome to Automotive API Framework Documentation
=================================================

About Automotive API Framework:
-------------------------------

.. toctree::
   :maxdepth: 1

   doc/standardization/standardization

Requirements:
-------------

.. toctree::
   :maxdepth: 1

   doc/requirements/requirements   

Meta Model:
-----------

.. toctree::
   :maxdepth: 1

   doc/meta_model/meta_model_purpose
   doc/meta_model/meta_model
   doc/meta_model/meta_model_function_adapter

Function Specification File:
-----------------------------

.. toctree::
   :maxdepth: 1

   doc/function_specification/function_specification_file
   doc/function_specification/function_specification_examples
   doc/function_specification/examples/speed_hazard_detection_example
   doc/function_specification/examples/vehicle_speed_fusion_multirate_example
   doc/function_specification/examples/wheel_speed_plausibility_check_example
   
Software Architecture:
----------------------

.. toctree::
   :maxdepth: 1

   doc/runtime_specification/runtime_specification_file   
   doc/runtime_specification/summary

Examples (for application-framework):
-------------------------------------

.. toctree::
   :maxdepth: 1

   doc/examples/bp-ifex-vaf/bp-ifex-vaf
   doc/examples/bp-vss-vaf/bp-vss-vaf