doc: about docs: move section

Moved About the documentation section under Dev model and contributions. Moved Glossary back to the main level of the docs. NCSDK-23303. Signed-off-by: Grzegorz Ferenc <[email protected]>
D-Triveni · Jan 8, 2024 · ec8d0bd · ec8d0bd
1 parent 5232725
commit ec8d0bd
Show file tree

Hide file tree

Showing 13 changed files with 14 additions and 7 deletions.
diff --git a/doc/_utils/redirects.py b/doc/_utils/redirects.py
@@ -77,7 +77,11 @@
     ("doc_structure", "documentation/structure"),
     ("doc_styleguide", "documentation/styleguide"),
     ("doc_templates", "documentation/templates"),
-    ("glossary", "documentation/glossary"),
+    ("documentation/build", "dev_model_and_contributions/documentation/build"),
+    ("documentation/build_process", "dev_model_and_contributions/documentation/doc_build_process"),
+    ("documentation/structure", "dev_model_and_contributions/documentation/structure"),
+    ("documentation/styleguide", "dev_model_and_contributions/documentation/styleguide"),
+    ("documentation/templates", "dev_model_and_contributions/documentation/templates"),
     ("ug_bt_fast_pair", "external_comp/bt_fast_pair"),
     ("ug_edge_impulse", "external_comp/edge_impulse"),
     ("ug_memfault", "external_comp/memfault"),

diff --git a/doc/nrf/dev_model_and_contributions.rst b/doc/nrf/dev_model_and_contributions.rst
@@ -26,3 +26,4 @@ This includes both the Nordic-specific and the open-source portions of the SDK.
    dev_model_and_contributions/ncs_distro
    dev_model_and_contributions/licenses
    dev_model_and_contributions/contributions
+   dev_model_and_contributions/documentation
diff --git a/doc/nrf/documentation.rst → ...model_and_contributions/documentation.rst b/doc/nrf/documentation.rst → ...model_and_contributions/documentation.rst
@@ -1,7 +1,7 @@
 .. _documentation:
 
-About this documentation
-########################
+|NCS| documentation
+###################
 
 The |NCS| documentation is written using the reStructuredText markup language (:file:`.rst` file extension) with Sphinx extensions and processed using Sphinx.
 It contains all information that is specific to the |NCS| and describes our libraries, samples, and applications.
@@ -13,9 +13,8 @@ The documentation follows specific conventions and templates proper to the |NCS|
    :maxdepth: 2
    :caption: Subpages:
 
-   documentation/glossary
    documentation/structure
-   documentation/build_process
+   documentation/doc_build_process
    documentation/build
    documentation/styleguide
    documentation/templates
diff --git a/doc/nrf/documentation/build.rst → ...and_contributions/documentation/build.rst b/doc/nrf/documentation/build.rst → ...and_contributions/documentation/build.rst
diff --git a/doc/nrf/documentation/build_process.rst → ...tions/documentation/doc_build_process.rst b/doc/nrf/documentation/build_process.rst → ...tions/documentation/doc_build_process.rst
diff --git a/...mentation/images/doc_structure_search.PNG → ...mentation/images/doc_structure_search.PNG b/...mentation/images/doc_structure_search.PNG → ...mentation/images/doc_structure_search.PNG
diff --git a/...n/images/doc_structure_search_results.PNG → ...n/images/doc_structure_search_results.PNG b/...n/images/doc_structure_search_results.PNG → ...n/images/doc_structure_search_results.PNG
diff --git a/doc/nrf/documentation/structure.rst → ...contributions/documentation/structure.rst b/doc/nrf/documentation/structure.rst → ...contributions/documentation/structure.rst
diff --git a/doc/nrf/documentation/styleguide.rst → ...ontributions/documentation/styleguide.rst b/doc/nrf/documentation/styleguide.rst → ...ontributions/documentation/styleguide.rst
diff --git a/doc/nrf/documentation/templates.rst → ...contributions/documentation/templates.rst b/doc/nrf/documentation/templates.rst → ...contributions/documentation/templates.rst
@@ -15,4 +15,4 @@ This folder also contains an RST :file:`cheat sheet` to help you getting started
    :glob:
    :caption: Subpages:
 
-   ../templates/*_README
+   ../../templates/*_README
diff --git a/doc/nrf/documentation/glossary.rst → doc/nrf/glossary.rst b/doc/nrf/documentation/glossary.rst → doc/nrf/glossary.rst
diff --git a/doc/nrf/index.rst b/doc/nrf/index.rst
@@ -53,6 +53,6 @@ Varied reference designs
    integrations
    dev_model_and_contributions
    releases_and_maturity
-   documentation
+   glossary
 
 ..  templates/cheat_sheet
diff --git a/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst
@@ -823,5 +823,8 @@ Documentation
   * The :ref:`ug_nrf70_developing_powersave_power_save_mode` section in the :ref:`ug_nrf70_developing_powersave` user guide.
   * The :ref:`nrf7002dk_nrf5340` page with a link to the `Wi-Fi Fundamentals course`_ in the `Nordic Developer Academy`_.
 
+  * The :ref:`dev-model` section with the :ref:`documentation` pages, previously listed separately.
+  * The :ref:`glossary` page by moving it back to the main hierarchy level.
+
 * Removed the Welcome to the |NCS| page.
   This page is replaced with existing :ref:`ncs_introduction` page.