diff --git a/overview/about-openharmony.rst b/overview/about-openharmony.rst index 2e3da69d81f5f942f0a0b94c2df73900803d1eef..c25696bfb91fb742508bab91531d5774ca4db0d0 100644 --- a/overview/about-openharmony.rst +++ b/overview/about-openharmony.rst @@ -1,4 +1,3 @@ - .. include:: ../definitions.rst About |main_project_name| @@ -29,12 +28,6 @@ Technical Architecture **Figure 1 Technical Architecture** .. figure:: figures/architecture.png - - :scale: 50 - :width: 100 px - :align: center - - Kernel Layer ------------------ diff --git a/quick-start/README.rst b/quick-start/README.rst index baaf56c6da369f1b6d121a31df8f82e465b6db5f..03fa12cb3e3ddeb30472d3e8c82af338f1c51c71 100644 --- a/quick-start/README.rst +++ b/quick-start/README.rst @@ -3,7 +3,7 @@ Getting Started Guide ##################### -|main_project_name| is a distributed OS that is designed to run on top of a variety of OS kernels ranging from Linux to RTOSs. To start with, you can build an |main_project_name| image using your preferred OS flavour using the supported boards. Currently, |main_project_name| supports Linux, Zephyr, and FreeRTOS kernels. The supported boards are listed in :ref:`supported-boards`. The configuration is set with certain default values which can be customized as per your preference. +|main_project_name| is a distributed OS that is designed to run on top of a variety of OS kernels ranging from Linux to RTOSs. To start with, you can build an |main_project_name| image using your preferred OS flavour using the supported boards. Currently, |main_project_name| supports Linux, Zephyr, and FreeRTOS kernels. The supported boards are listed under :ref:`Supported Boards <supported-boards>`. The configuration is set with certain default values which can be customized as per your preference. .. toctree:: :maxdepth: 2 diff --git a/quick-start/linux-flavour.rst b/quick-start/linux-flavour.rst index 70158af68610ada59a3287b047f7d4b53cfe89a1..bb587d4cda6968ca89cf196340db878b1c1074c2 100644 --- a/quick-start/linux-flavour.rst +++ b/quick-start/linux-flavour.rst @@ -45,12 +45,11 @@ Supported machines * - qemuarm64 - Emulator * - seco-intel-b68 (SECO SBC-B68) - - `Details <https://www.seco.com/en/products/sbc-b68-enuc>`_ + - `Details <https://www.seco.com/en/products/sbc-b68-enuc>`__ * - stm32mp1-av96 (96Boards Avenger96) - - `Details <https://www.96boards.org/product/avenger96/>`_ + - `Details <https://www.96boards.org/product/avenger96/>`__ * - seco-imx8mm-c61 (SECO SBC-C61) - - `Details <https://www.seco.com/en/products/sbc-c61>`_ - + - `Details <https://www.seco.com/en/products/sbc-c61>`__ Prerequisites ************* diff --git a/quick-start/zephyr-flavour.rst b/quick-start/zephyr-flavour.rst index 9d7416c9c66ef9c8c98dfa61358cb55b3260542c..b578353d5cba5215810e1e03ad383ab7d0b9e75d 100644 --- a/quick-start/zephyr-flavour.rst +++ b/quick-start/zephyr-flavour.rst @@ -30,9 +30,9 @@ Supported machines * - qemu-cortex-m3 - Emulator * - 96b-nitrogen (96Boards Nitrogen) - - `Details <https://www.96boards.org/product/nitrogen/>`_ + - `Details <https://www.96boards.org/product/nitrogen/>`__ * - 96b-avenger96 (96Boards Avenger96) - - `Details <https://www.96boards.org/product/avenger96/>`_ + - `Details <https://www.96boards.org/product/avenger96/>`__ Prerequisites ************* diff --git a/readme/Contribution Process.rst b/readme/Contribution Process.rst index 5165e26511e0240abefbbb58a0325e28ac106a4c..d93fc5c9770033d9c677cff937b052b517806dbb 100644 --- a/readme/Contribution Process.rst +++ b/readme/Contribution Process.rst @@ -62,11 +62,6 @@ Prerequisites For downloading tools, downloading source code, and building and running |main_project_name| image, see :ref:`Getting Started <BuildOpenharmony>`. -Coding guidelines -***************** - -Refer to the :ref:`Contributing Code <Contributingcode>` section of the documentation for additional details. - Contribution Workflow ********************* diff --git a/readme/reStructuredText Basics.rst b/readme/reStructuredText Basics.rst index d9cbef204149264a64e32f6c4975cb4e63333f0b..54cc041f441e90857b9937e433841d42c06589cc 100644 --- a/readme/reStructuredText Basics.rst +++ b/readme/reStructuredText Basics.rst @@ -24,13 +24,10 @@ Sphinx comes with a script called sphinx-quickstart that sets up a source direct The below quickstart screen appears as shown below: -.. figure:: images/quick-start.PNG - - :align: center - :alt: Quickstart overview - **Figure 1 quickstart utility** +.. figure:: images/quick-start.PNG + For more information on Sphinx Quickstart, refer https://sphinx-rtd-tutorial.readthedocs.io/en/latest/sphinx-quickstart.html. Defining Document Structure diff --git a/supported-boards/96b-Avenger.rst b/supported-boards/96b-Avenger.rst index 01159dc6a8092c75687f828c7a40acecc33d2abc..ec5c82756e28d1d6d29aa169d8853590cae5ff14 100644 --- a/supported-boards/96b-Avenger.rst +++ b/supported-boards/96b-Avenger.rst @@ -91,8 +91,6 @@ For Zephyr, there is no automation as for now. To have the ELF file in the files * Include it in the image before flashing the card/eMMC * Copy the file manually to the card or just *scp* it to the board after you set up networking. -.. _linux-image-1: - Linux image =========== diff --git a/supported-boards/96b-nitrogen.rst b/supported-boards/96b-nitrogen.rst index 977fa71ef9701ac2acc08b57e8abdc50760f84fc..96651986d09d4936ac91acb6666816f6e39d5955 100644 --- a/supported-boards/96b-nitrogen.rst +++ b/supported-boards/96b-nitrogen.rst @@ -42,7 +42,7 @@ Supported image Building an application ======================= -|main_project_name|OS Zephyr flavour is based on Zephyr kernel. +|main_project_name| OS Zephyr flavour is based on Zephyr kernel. * Source the environment with proper template settings, flavour being zephyr and target machine being 96b-nitrogen: diff --git a/supported-boards/README.rst b/supported-boards/README.rst index b93ea2c238d194484a63506beb65aa3e94163ddb..565ca3fad844493284bec3887ffcdd2af969cf2e 100644 --- a/supported-boards/README.rst +++ b/supported-boards/README.rst @@ -1,4 +1,4 @@ -.. supported-boards: +.. _supported-boards: .. include:: ../definitions.rst diff --git a/supported-boards/seco-imx8mm-c61.rst b/supported-boards/seco-imx8mm-c61.rst index 4790cbfdaef3a7c29373441d52197bda2c11b8cf..4b26c07f24f6be8a488f5069263fa2f671de2171 100644 --- a/supported-boards/seco-imx8mm-c61.rst +++ b/supported-boards/seco-imx8mm-c61.rst @@ -51,7 +51,6 @@ To generate images for eMMC, refer to the following flashing procedure. Flashing OHOS image ******************* -.. _linux-image-1: Linux image ===========