Add prefix to docs subdirectory

nfdi4cat · Oct 12, 2024 · c505b30 · c505b30
1 parent 9a7eded
commit c505b30
Show file tree

Hide file tree

Showing 16 changed files with 14 additions and 10 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,6 +1,10 @@
 # Guidelines and Maintenance Documentation
 
-We use [Sphinx](https://www.sphinx-doc.org/) as documentation builder with the [furo](https://github.com/pradyunsg/furo) theme and [MySt](https://mystmd.org/) to support extended markdown.
+We use [Sphinx](https://www.sphinx-doc.org/) as documentation builder with the [furo](https://github.com/pradyunsg/furo) theme
+and [MySt](https://mystmd.org/) to support extended markdown.
 
-To get an overview about the styling features supported visit the [furo theme documentation](https://pradyunsg.me/furo/kitchen-sink/).
-Another source is the great [Executable Books](https://executablebooks.org/en/latest/) project which is also built upon Sphinx.
+To get an overview about the styling features supported visit the [furo theme documentation](https://pradyunsg.me/furo/kitchen-sink/)
+or the [MyST authoring documentation](https://mystmd.org/guide/typography).
+
+You may wonder why the sub-folders here have a `docs_` prefix.
+This is to clearly distinguish them from the pyLODE-vocabulary documentation after deployment to gh-pages.
diff --git a/docs/maintenance/creating-docs-locally.md → ...docs_maintenance/creating-docs-locally.md b/docs/maintenance/creating-docs-locally.md → ...docs_maintenance/creating-docs-locally.md
diff --git a/docs/maintenance/handling-ID-requests.md → .../docs_maintenance/handling-ID-requests.md b/docs/maintenance/handling-ID-requests.md → .../docs_maintenance/handling-ID-requests.md
diff --git a/docs/usage/about.md → docs/docs_usage/about.md b/docs/usage/about.md → docs/docs_usage/about.md
diff --git a/docs/usage/guidelines.md → docs/docs_usage/guidelines.md b/docs/usage/guidelines.md → docs/docs_usage/guidelines.md
diff --git a/docs/usage/how-to-contribute.md → docs/docs_usage/how-to-contribute.md b/docs/usage/how-to-contribute.md → docs/docs_usage/how-to-contribute.md
@@ -2,5 +2,5 @@
 
 ```{todo}
 Move and merge documentation on contribution process from [readme](https://github.com/nfdi4cat/voc4cat/blob/main/README.md)
-and {ref}`guidelines-v2.0 <usage/published-guidelines-v2:5. contribution step-by-step guide>` here.
+and {ref}`guidelines-v2.0 <docs_usage/published-guidelines-v2:5. contribution step-by-step guide>` here.
 ```
diff --git a/docs/usage/how-to-use.md → docs/docs_usage/how-to-use.md b/docs/usage/how-to-use.md → docs/docs_usage/how-to-use.md
diff --git a/docs/usage/media/cc-by-license.png → docs/docs_usage/media/cc-by-license.png b/docs/usage/media/cc-by-license.png → docs/docs_usage/media/cc-by-license.png
diff --git a/docs/usage/media/contributions-steps.png → .../docs_usage/media/contributions-steps.png b/docs/usage/media/contributions-steps.png → .../docs_usage/media/contributions-steps.png
diff --git a/docs/usage/media/dechema.png → docs/docs_usage/media/dechema.png b/docs/usage/media/dechema.png → docs/docs_usage/media/dechema.png
diff --git a/docs/usage/media/dfg.png → docs/docs_usage/media/dfg.png b/docs/usage/media/dfg.png → docs/docs_usage/media/dfg.png
diff --git a/docs/usage/media/nfdi4cat-partners.png → docs/docs_usage/media/nfdi4cat-partners.png b/docs/usage/media/nfdi4cat-partners.png → docs/docs_usage/media/nfdi4cat-partners.png
diff --git a/docs/usage/media/referenced-in-qrcodes.png → ...ocs_usage/media/referenced-in-qrcodes.png b/docs/usage/media/referenced-in-qrcodes.png → ...ocs_usage/media/referenced-in-qrcodes.png
diff --git a/docs/usage/media/workflow.png → docs/docs_usage/media/workflow.png b/docs/usage/media/workflow.png → docs/docs_usage/media/workflow.png
diff --git a/docs/usage/published-guidelines-v2.md → docs/docs_usage/published-guidelines-v2.md b/docs/usage/published-guidelines-v2.md → docs/docs_usage/published-guidelines-v2.md
diff --git a/docs/index.md b/docs/index.md
@@ -82,31 +82,31 @@ For example, the compact URI of `https://w3id.org/nfdi4cat/voc4cat_0005001` is `
 :hidden:
 Overview <self>
 GitHub page <https://github.com/nfdi4cat/voc4cat>
-About <usage/about>
+About <docs_usage/about>
 ```
 
 ```{toctree}
 :caption: For Users
 :hidden:
 :maxdepth: 2
 
-usage/how-to-use
-usage/how-to-contribute
-usage/guidelines
+docs_usage/how-to-use
+docs_usage/how-to-contribute
+docs_usage/guidelines
 ```
 
 ```{toctree}
 :caption: For Maintainers
 :glob:
 :hidden:
 
-maintenance/*
+docs_maintenance/*
 ```
 
 ```{toctree}
 :caption: Guidelines (V2.0)
 :hidden:
 :maxdepth: 3
 
-All-in-one-page (as published) <usage/published-guidelines-v2>
+All-in-one-page (as published) <docs_usage/published-guidelines-v2>
 ```