From 7ad2f7672046cd9b6a5e3202569218e3fc2d7eaa Mon Sep 17 00:00:00 2001 From: Anas Nashif Date: Tue, 5 Apr 2022 17:36:48 -0400 Subject: [PATCH] doc: remove guides and split content Remove the old guides section and move all remaining items into new sections. Signed-off-by: Anas Nashif --- .../flash_debug}/nordic_segger.rst | 0 doc/develop/index.rst | 1 + doc/{guides => develop/tools}/coccinelle.rst | 0 doc/develop/tools/index.rst | 10 ++++++++++ .../platformio/img/platformio-ide-vscode.png | Bin .../tools}/platformio/img/platformio-logo.png | Bin .../tools}/platformio/index.rst | 0 doc/guides/index.rst | 12 ------------ doc/hardware/index.rst | 1 + doc/{guides => hardware}/porting/arch.rst | 0 .../porting/board/hierarchy.png | Bin .../porting/board_porting.rst | 0 doc/{guides => hardware}/porting/index.rst | 0 doc/{guides => hardware}/porting/shields.rst | 0 doc/index-tex.rst | 1 - doc/index.rst | 15 +++++++-------- doc/services/index.rst | 1 + .../portability/cmsis_rtos_v1.rst | 0 .../portability/cmsis_rtos_v2.rst | 0 doc/{guides => services}/portability/index.rst | 0 doc/{guides => services}/portability/posix.rst | 0 doc/{guides => services}/portability/posix.svg | Bin 22 files changed, 20 insertions(+), 21 deletions(-) rename doc/{guides/tools => develop/flash_debug}/nordic_segger.rst (100%) rename doc/{guides => develop/tools}/coccinelle.rst (100%) create mode 100644 doc/develop/tools/index.rst rename doc/{guides => develop/tools}/platformio/img/platformio-ide-vscode.png (100%) rename doc/{guides => develop/tools}/platformio/img/platformio-logo.png (100%) rename doc/{guides => develop/tools}/platformio/index.rst (100%) delete mode 100644 doc/guides/index.rst rename doc/{guides => hardware}/porting/arch.rst (100%) rename doc/{guides => hardware}/porting/board/hierarchy.png (100%) rename doc/{guides => hardware}/porting/board_porting.rst (100%) rename doc/{guides => hardware}/porting/index.rst (100%) rename doc/{guides => hardware}/porting/shields.rst (100%) rename doc/{guides => services}/portability/cmsis_rtos_v1.rst (100%) rename doc/{guides => services}/portability/cmsis_rtos_v2.rst (100%) rename doc/{guides => services}/portability/index.rst (100%) rename doc/{guides => services}/portability/posix.rst (100%) rename doc/{guides => services}/portability/posix.svg (100%) diff --git a/doc/guides/tools/nordic_segger.rst b/doc/develop/flash_debug/nordic_segger.rst similarity index 100% rename from doc/guides/tools/nordic_segger.rst rename to doc/develop/flash_debug/nordic_segger.rst diff --git a/doc/develop/index.rst b/doc/develop/index.rst index 31e6d2102fd..23f65c4ccfb 100644 --- a/doc/develop/index.rst +++ b/doc/develop/index.rst @@ -15,3 +15,4 @@ Developing with Zephyr modules.rst west/index test/index + tools/index diff --git a/doc/guides/coccinelle.rst b/doc/develop/tools/coccinelle.rst similarity index 100% rename from doc/guides/coccinelle.rst rename to doc/develop/tools/coccinelle.rst diff --git a/doc/develop/tools/index.rst b/doc/develop/tools/index.rst new file mode 100644 index 00000000000..523829dac9f --- /dev/null +++ b/doc/develop/tools/index.rst @@ -0,0 +1,10 @@ +.. _dev_tools: + +Tools and IDEs +############## + +.. toctree:: + :maxdepth: 1 + + coccinelle.rst + platformio/index.rst diff --git a/doc/guides/platformio/img/platformio-ide-vscode.png b/doc/develop/tools/platformio/img/platformio-ide-vscode.png similarity index 100% rename from doc/guides/platformio/img/platformio-ide-vscode.png rename to doc/develop/tools/platformio/img/platformio-ide-vscode.png diff --git a/doc/guides/platformio/img/platformio-logo.png b/doc/develop/tools/platformio/img/platformio-logo.png similarity index 100% rename from doc/guides/platformio/img/platformio-logo.png rename to doc/develop/tools/platformio/img/platformio-logo.png diff --git a/doc/guides/platformio/index.rst b/doc/develop/tools/platformio/index.rst similarity index 100% rename from doc/guides/platformio/index.rst rename to doc/develop/tools/platformio/index.rst diff --git a/doc/guides/index.rst b/doc/guides/index.rst deleted file mode 100644 index 9d3e9ed2986..00000000000 --- a/doc/guides/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _user_guides: - -User and Developer Guides -######################### - -.. toctree:: - :maxdepth: 1 - - coccinelle.rst - platformio/index.rst - portability/index.rst - porting/index diff --git a/doc/hardware/index.rst b/doc/hardware/index.rst index 0954a918a83..8dceb73b92c 100644 --- a/doc/hardware/index.rst +++ b/doc/hardware/index.rst @@ -10,3 +10,4 @@ Hardware Support emulator/index.rst peripherals/index.rst pinctrl/index.rst + porting/index diff --git a/doc/guides/porting/arch.rst b/doc/hardware/porting/arch.rst similarity index 100% rename from doc/guides/porting/arch.rst rename to doc/hardware/porting/arch.rst diff --git a/doc/guides/porting/board/hierarchy.png b/doc/hardware/porting/board/hierarchy.png similarity index 100% rename from doc/guides/porting/board/hierarchy.png rename to doc/hardware/porting/board/hierarchy.png diff --git a/doc/guides/porting/board_porting.rst b/doc/hardware/porting/board_porting.rst similarity index 100% rename from doc/guides/porting/board_porting.rst rename to doc/hardware/porting/board_porting.rst diff --git a/doc/guides/porting/index.rst b/doc/hardware/porting/index.rst similarity index 100% rename from doc/guides/porting/index.rst rename to doc/hardware/porting/index.rst diff --git a/doc/guides/porting/shields.rst b/doc/hardware/porting/shields.rst similarity index 100% rename from doc/guides/porting/shields.rst rename to doc/hardware/porting/shields.rst diff --git a/doc/index-tex.rst b/doc/index-tex.rst index 5bfda356af0..669882720ad 100644 --- a/doc/index-tex.rst +++ b/doc/index-tex.rst @@ -20,7 +20,6 @@ Zephyr Project Documentation connectivity/index.rst services/index.rst reference/index.rst - guides/index.rst hardware/index.rst security/index.rst contribute/index.rst diff --git a/doc/index.rst b/doc/index.rst index a34be483684..f6d6e6325c9 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -41,7 +41,7 @@ licensing, as described in :ref:`Zephyr_Licensing`.

Introducing the Zephyr Project: overview, architecture, features, and licensing

  • - +

    Getting Started Guide

     @@ -65,11 +65,11 @@ licensing, as described in :ref:`Zephyr_Licensing`. by Zephyr

  • - + -

    API Reference

    +

    Hardware Support

     -

    API Documentation, Zephyr configuration, and subsystem Reference

    +

    Information about supported architectures, supported hardware and porting guides

  • @@ -86,11 +86,11 @@ licensing, as described in :ref:`Zephyr_Licensing`.

    List of supported boards and platforms.

  • - + -

    User and Developer Guides

    +

    OS Services

     -

    User and Developer Guides, including tools and tips

    +

    OS Services and guides how to use them with Zephyr

    • @@ -108,7 +108,6 @@ Sections connectivity/index.rst services/index.rst reference/index.rst - guides/index.rst hardware/index.rst security/index.rst contribute/index.rst diff --git a/doc/services/index.rst b/doc/services/index.rst index 772ca653122..775eecac018 100644 --- a/doc/services/index.rst +++ b/doc/services/index.rst @@ -17,6 +17,7 @@ OS Services resource_management/index.rst notify.rst pm/index.rst + portability/index.rst shell/index.rst settings/index.rst smf/index.rst diff --git a/doc/guides/portability/cmsis_rtos_v1.rst b/doc/services/portability/cmsis_rtos_v1.rst similarity index 100% rename from doc/guides/portability/cmsis_rtos_v1.rst rename to doc/services/portability/cmsis_rtos_v1.rst diff --git a/doc/guides/portability/cmsis_rtos_v2.rst b/doc/services/portability/cmsis_rtos_v2.rst similarity index 100% rename from doc/guides/portability/cmsis_rtos_v2.rst rename to doc/services/portability/cmsis_rtos_v2.rst diff --git a/doc/guides/portability/index.rst b/doc/services/portability/index.rst similarity index 100% rename from doc/guides/portability/index.rst rename to doc/services/portability/index.rst diff --git a/doc/guides/portability/posix.rst b/doc/services/portability/posix.rst similarity index 100% rename from doc/guides/portability/posix.rst rename to doc/services/portability/posix.rst diff --git a/doc/guides/portability/posix.svg b/doc/services/portability/posix.svg similarity index 100% rename from doc/guides/portability/posix.svg rename to doc/services/portability/posix.svg