From 5c03c72335c2acbf50c189214edc6d0ddba0a33b Mon Sep 17 00:00:00 2001 From: Gururaj Shetty <gururaj.shetty@huawei.com> Date: Fri, 26 Nov 2021 21:00:21 +0530 Subject: [PATCH] docs: Restructure Main Page * Restructure main page * Supported-technologies folder moved one level up * This is part of MR: https://booting.oniroproject.org/distro/docs/-/merge_requests/227 * Rework on the documentation flow * Closes: https://git.ostc-eu.org/distro/docs/-/issues/80 Signed-off-by: Gururaj Shetty <gururaj.shetty@huawei.com> --- docs/index.rst | 33 ++++++++++++++++--- docs/os/index.rst | 1 - docs/os/supported-technologies/index.rst | 17 ---------- .../supported-technologies/openthread.rst | 0 4 files changed, 28 insertions(+), 23 deletions(-) delete mode 100644 docs/os/supported-technologies/index.rst rename docs/{os => }/supported-technologies/openthread.rst (100%) diff --git a/docs/index.rst b/docs/index.rst index 343710e1..d9904419 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,15 +6,38 @@ Build System Guide ################## .. toctree:: - :maxdepth: 1 - + :caption: Quick Start + :maxdepth: 2 + oniro-quick-build - yocto-build-system/index - repo-workspace + +.. toctree:: + :caption: Oniro Project Blueprints + :maxdepth: 2 + + Oniro Project Blueprints <https://docs.oniroproject.org/projects/blueprints> + +.. toctree:: + :caption: Build System Guide + :maxdepth: 2 + + Overview <yocto-build-system/index> + Creating Workspace <repo-workspace> build-flavours/index oniro-build/index os/index ci/index supported-images hardware-support/index - fallback-devices-support + +.. toctree:: + :caption: Supported Technologies + :maxdepth: 2 + + supported-technologies/openthread + +.. toctree:: + :caption: Troubleshoot + :maxdepth: 2 + + fallback-devices-support diff --git a/docs/os/index.rst b/docs/os/index.rst index 5ade90a5..11138cfb 100644 --- a/docs/os/index.rst +++ b/docs/os/index.rst @@ -14,4 +14,3 @@ details various aspects for each kernel type. :maxdepth: 2 linux/index - supported-technologies/index diff --git a/docs/os/supported-technologies/index.rst b/docs/os/supported-technologies/index.rst deleted file mode 100644 index 3b6fae39..00000000 --- a/docs/os/supported-technologies/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. SPDX-FileCopyrightText: Huawei Inc. -.. -.. SPDX-License-Identifier: CC-BY-4.0 - -.. include:: ../../definitions.rst - -.. _SupportedTechnologies: - -Supported Technologies -###################### - -This section details the supported technologies in |main_project_name|. - -.. toctree:: - :maxdepth: 1 - - openthread diff --git a/docs/os/supported-technologies/openthread.rst b/docs/supported-technologies/openthread.rst similarity index 100% rename from docs/os/supported-technologies/openthread.rst rename to docs/supported-technologies/openthread.rst -- GitLab