From 3693c819255556a108dc6c616f1a58151050aef0 Mon Sep 17 00:00:00 2001
From: Timo Koch <timok@simula.no>
Date: Wed, 29 Jan 2025 11:27:37 +0000
Subject: [PATCH] [doc][doxygen] Rename usage doc to Understanding DuMux
---
doc/doxygen/DoxygenDumuxLayout.xml | 2 +-
doc/doxygen/groups/usage.md | 12 ------------
doc/doxygen/pages/understanding-dumux.md | 10 ++++++++++
3 files changed, 11 insertions(+), 13 deletions(-)
delete mode 100644 doc/doxygen/groups/usage.md
create mode 100644 doc/doxygen/pages/understanding-dumux.md
diff --git a/doc/doxygen/DoxygenDumuxLayout.xml b/doc/doxygen/DoxygenDumuxLayout.xml
index 43e9485f20..7009dc0296 100644
--- a/doc/doxygen/DoxygenDumuxLayout.xml
+++ b/doc/doxygen/DoxygenDumuxLayout.xml
@@ -18,7 +18,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
<!-- For this write @addtogroup <groupname> at the top of that markdown page -->
<tab type="user" url="@ref external-libraries" visible="yes" title="External libraries" intro=""/>
<tab type="user" url="@ref examples-and-tutorials" visible="yes" title="Examples and tutorials" intro=""/>
- <tab type="usergroup" url="@ref usage-documentation" visible="yes" title="Usage documentation" >
+ <tab type="usergroup" url="@ref understanding-dumux" visible="yes" title="Understanding DuMux" >
<tab type="user" url="@ref runtime-parameters" visible="yes" title="Runtime parameters" intro=""/>
<tab type="user" url="@ref running-in-parallel" visible="yes" title="Running in parallel" intro=""/>
<tab type="user" url="@ref input-and-output-formats" visible="yes" title="Input and output formats" intro=""/>
diff --git a/doc/doxygen/groups/usage.md b/doc/doxygen/groups/usage.md
deleted file mode 100644
index c60b42d3ee..0000000000
--- a/doc/doxygen/groups/usage.md
+++ /dev/null
@@ -1,12 +0,0 @@
-# Usage documentation
-
-This part of the documentation is dedicated to provide explanations,
-tips & tricks on how to use DuMux programs and will introduce you to some
-of the conventions. In particular, this includes how to configure a DuMux
-program at runtime, input and output file formats (I/O), and how to run
-DuMux programs in parallel.
-
-* @ref runtime-parameters
-* @ref running-in-parallel
-* @ref input-and-output-formats
-* @ref directory-structure
diff --git a/doc/doxygen/pages/understanding-dumux.md b/doc/doxygen/pages/understanding-dumux.md
new file mode 100644
index 0000000000..d65b148e68
--- /dev/null
+++ b/doc/doxygen/pages/understanding-dumux.md
@@ -0,0 +1,10 @@
+# Understanding DuMux
+
+This part of the documentation is dedicated to provide explanations,
+tips & tricks on how to use DuMux and will introduce you to some
+of the conventions and concepts.
+
+* @ref runtime-parameters
+* @ref running-in-parallel
+* @ref input-and-output-formats
+* @ref directory-structure
--
GitLab