mirror of
https://github.com/apache/nuttx.git
synced 2026-06-04 23:03:27 +08:00
convert TODOs to actual TODO banner and improve general presentation of different sections
This commit is contained in:
+11
-8
@@ -1,28 +1,31 @@
|
||||
.. note::
|
||||
The present documentation is a recent addition to NuttX and was migrated from previous
|
||||
documentation content. For this reason, it is possible you may find broken links or
|
||||
formatting errors. You can help contribute fixes or improvements to this documentation
|
||||
by following these :doc:`instructions <contributing/documentation>`.
|
||||
|
||||
.. tip::
|
||||
You can find the old documentation `here <https://cwiki.apache.org/confluence/display/NUTTX/Documentation>`_.
|
||||
|
||||
===================
|
||||
NuttX Documentation
|
||||
===================
|
||||
|
||||
NuttX is a real-time operating system (RTOS) with an emphasis on standards compliance and small footprint. Scalable from 8-bit to 32-bit microcontroller environments, the primary governing standards in NuttX are Posix and ANSI standards. Additional standard APIs from Unix and other common RTOS’s (such as VxWorks) are adopted for functionality not available under these standards, or for functionality that is not appropriate for deeply-embedded environments (such as fork()).
|
||||
|
||||
.. warning::
|
||||
These pages are meant to be an experiment in replacing the `Apache NuttX Documentation <https://cwiki.apache.org/confluence/display/NUTTX/Nuttx>`_
|
||||
with something easier to navigate, extend, and modify.
|
||||
This is a work in progress, some formatting issues may still be present and are being worked on. Also, some links may be broken. Please
|
||||
refer to :doc:`contributing documentation<contributing/documentation>` to propose fixes/improvements.
|
||||
|
||||
Last Updated: |today|
|
||||
|
||||
.. toctree::
|
||||
:caption: Contents:
|
||||
:caption: Table of Contents
|
||||
:maxdepth: 2
|
||||
|
||||
Home <self>
|
||||
introduction/index.rst
|
||||
quickstart/index.rst
|
||||
reference/index.rst
|
||||
components/index.rst
|
||||
applications/index.rst
|
||||
boards/index.rst
|
||||
reference/index.rst
|
||||
guides/index.rst
|
||||
releases/index.rst
|
||||
contributing/index.rst
|
||||
|
||||
Reference in New Issue
Block a user