diff --git a/doc/development_process/api_lifecycle.rst b/doc/development_process/api_lifecycle.rst index f047ede9c05..785d6202451 100644 --- a/doc/development_process/api_lifecycle.rst +++ b/doc/development_process/api_lifecycle.rst @@ -18,7 +18,7 @@ no longer optimal or supported by the underlying platforms. API Life Cycle An up-to-date table of all APIs and their maturity level can be found in the -:ref:`api_stability` page. +:ref:`api_overview` page. Experimental ************* @@ -87,7 +87,7 @@ An API can be declared ``stable`` after fulfilling the following requirements: In order to declare an API ``stable``, the following steps need to be followed: #. A Pull Request must be opened that changes the corresponding entry in the - :ref:`api_stability` table + :ref:`api_overview` table #. An email must be sent to the ``devel`` mailing list announcing the API upgrade request #. The Pull Request must be submitted for discussion in the next diff --git a/doc/reference/index.rst b/doc/reference/index.rst index 37625ae3b0e..4a31ca357d6 100644 --- a/doc/reference/index.rst +++ b/doc/reference/index.rst @@ -6,7 +6,7 @@ API Reference .. toctree:: :maxdepth: 1 - stability.rst + overview.rst terminology.rst audio/index.rst bluetooth/index.rst diff --git a/doc/reference/stability.rst b/doc/reference/overview.rst similarity index 94% rename from doc/reference/stability.rst rename to doc/reference/overview.rst index da4302db1ed..1f83e843511 100644 --- a/doc/reference/stability.rst +++ b/doc/reference/overview.rst @@ -1,10 +1,10 @@ -.. _api_stability: +.. _api_overview: -API Stability -############# +API Overview +############ -The table below lists the available documented APIs in Zephyr, their -:ref:`current status ` and the release that introduced them. +The table lists Zephyr's APIs and information about them, including their +current :ref:`stability level `. .. list-table:: :header-rows: 1