doc: rename reference/stability to reference/overview
This page has a lot more information about APIs than just stability, and I believe it's currently our only exhaustive list of APIs. Rename it to API Overview. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
This commit is contained in:
parent
42f9d14a3f
commit
4ba332aca8
3 changed files with 8 additions and 8 deletions
|
@ -18,7 +18,7 @@ no longer optimal or supported by the underlying platforms.
|
||||||
API Life Cycle
|
API Life Cycle
|
||||||
|
|
||||||
An up-to-date table of all APIs and their maturity level can be found in the
|
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
|
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:
|
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
|
#. 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
|
#. An email must be sent to the ``devel`` mailing list announcing the API
|
||||||
upgrade request
|
upgrade request
|
||||||
#. The Pull Request must be submitted for discussion in the next
|
#. The Pull Request must be submitted for discussion in the next
|
||||||
|
|
|
@ -6,7 +6,7 @@ API Reference
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
stability.rst
|
overview.rst
|
||||||
terminology.rst
|
terminology.rst
|
||||||
audio/index.rst
|
audio/index.rst
|
||||||
bluetooth/index.rst
|
bluetooth/index.rst
|
||||||
|
|
|
@ -1,10 +1,10 @@
|
||||||
.. _api_stability:
|
.. _api_overview:
|
||||||
|
|
||||||
API Stability
|
API Overview
|
||||||
#############
|
############
|
||||||
|
|
||||||
The table below lists the available documented APIs in Zephyr, their
|
The table lists Zephyr's APIs and information about them, including their
|
||||||
:ref:`current status <api_lifecycle>` and the release that introduced them.
|
current :ref:`stability level <api_lifecycle>`.
|
||||||
|
|
||||||
.. list-table::
|
.. list-table::
|
||||||
:header-rows: 1
|
:header-rows: 1
|
Loading…
Add table
Add a link
Reference in a new issue