diff --git a/web/content/docs/_index.pandoc b/web/content/docs/_index.pandoc index ef8d32e4aa633df71517ee51fb9e238b6c8c88fb..8c286539084e7e80affc58c955543ee22ec8fc77 100644 --- a/web/content/docs/_index.pandoc +++ b/web/content/docs/_index.pandoc @@ -3,13 +3,13 @@ title = "Documentation" [[sections]] name = "User Guide" -url = "/docs/userguide" +url = "/docs/userguide/basics/introduction/" text = "Download, install and run an OGS benchmark in 5 minutes! No development setup required." icon = "fal fa-users" [[sections]] name = "Developer Guide" -url = "/docs/devguide" +url = "/docs/devguide/getting-started/introduction/" text = "You want to contribute to the OpenGeoSys project or implement a custom feature? In the Developer Guide you will find everything to get you started into OpenGeoSys development. Experienced developers will find a comprehensive list of advanced development topics." icon = "fal fa-laptop-code" @@ -21,7 +21,7 @@ icon = "fal fa-rabbit-fast" [[sections]] name = "Tools & Workflows" -url = "/docs/tools" +url = "/docs/tools/getting-started/overview/" text = "Helpful tools for pre- and postprocessing as well as complete model setup workflows." icon = "fal fa-tools" diff --git a/web/content/docs/benchmarks/elliptic/elliptic-dirichlet-volumetric-source-term.pandoc b/web/content/docs/benchmarks/elliptic/elliptic-dirichlet-volumetric-source-term.pandoc index 84e5e7a772b0dce70ea2c7e039b6299a15ddc370..251b18c787d1d47604ece04e70239d5b3f73d6e3 100644 --- a/web/content/docs/benchmarks/elliptic/elliptic-dirichlet-volumetric-source-term.pandoc +++ b/web/content/docs/benchmarks/elliptic/elliptic-dirichlet-volumetric-source-term.pandoc @@ -5,8 +5,6 @@ project = "Elliptic/square_1x1_GroundWaterFlow/square_1e2_volumetricsourceterm.p author = "Tom Fischer" weight = 102 -aliases = [ "/docs/benchmarks/" ] # First benchmark page - [menu] [menu.benchmarks] parent = "elliptic" diff --git a/web/content/docs/benchmarks/elliptic/elliptic-dirichlet.pandoc b/web/content/docs/benchmarks/elliptic/elliptic-dirichlet.pandoc index d28712fa05e885020ca72295f628e169ca2857d6..b6741717cfb49c5fc99d41cc9e8b56909ae6ef0f 100644 --- a/web/content/docs/benchmarks/elliptic/elliptic-dirichlet.pandoc +++ b/web/content/docs/benchmarks/elliptic/elliptic-dirichlet.pandoc @@ -5,8 +5,6 @@ project = "Elliptic/square_1x1_GroundWaterFlow/square_1e2.prj" author = "Dmitri Naumov" weight = 102 -aliases = [ "/docs/benchmarks/" ] # First benchmark page - [menu] [menu.benchmarks] parent = "elliptic" diff --git a/web/content/docs/benchmarks/elliptic/poisson_equation.pandoc b/web/content/docs/benchmarks/elliptic/poisson_equation.pandoc index cad433cb5301bff38a176ed0ddc38b6af020b2c3..7ae46cb99bd887236f6584acc5120f7df892f80e 100644 --- a/web/content/docs/benchmarks/elliptic/poisson_equation.pandoc +++ b/web/content/docs/benchmarks/elliptic/poisson_equation.pandoc @@ -5,8 +5,6 @@ project = "Elliptic/square_1x1_GroundWaterFlow_Python/square_1e3_poisson_sin_x_s author = "Tom Fischer" weight = 102 -aliases = [ "/docs/benchmarks/" ] # First benchmark page - [menu] [menu.benchmarks] parent = "elliptic" diff --git a/web/content/docs/devguide/_index.md b/web/content/docs/devguide/_index.md new file mode 100644 index 0000000000000000000000000000000000000000..c346f72f72bcd2d329796dc460dfa1a303d7211c --- /dev/null +++ b/web/content/docs/devguide/_index.md @@ -0,0 +1,3 @@ ++++ +title = "Developer Guide" ++++ diff --git a/web/content/docs/devguide/getting-started/introduction.pandoc b/web/content/docs/devguide/getting-started/introduction.pandoc index 69597275811ac4ea5c3b5b0377f505b5cab3d363..d3e4a9b542d9b434acd00de6f64d8cd8c70bcc01 100644 --- a/web/content/docs/devguide/getting-started/introduction.pandoc +++ b/web/content/docs/devguide/getting-started/introduction.pandoc @@ -4,8 +4,6 @@ title = "Welcome!" author = "Lars Bilke" weight = 1001 -aliases = [ "/docs/devguide/" ] # First devguide page - [menu] [menu.devguide] parent = "getting-started" diff --git a/web/content/docs/tools/_index.md b/web/content/docs/tools/_index.md new file mode 100644 index 0000000000000000000000000000000000000000..fd9e1cf94f6b2637e5c7c17a88a9b5aa86e26f3d --- /dev/null +++ b/web/content/docs/tools/_index.md @@ -0,0 +1,3 @@ ++++ +title = "Tools" ++++ diff --git a/web/content/docs/tools/getting-started/overview.pandoc b/web/content/docs/tools/getting-started/overview.pandoc index 670bd3aec323af5cd13c1164e6c67e3105ea943b..40803577c0d424041af560fa7dbc6c4d3b0356bf 100644 --- a/web/content/docs/tools/getting-started/overview.pandoc +++ b/web/content/docs/tools/getting-started/overview.pandoc @@ -4,8 +4,6 @@ title = "Introduction" author = "Lars Bilke" weight = 100 -aliases = [ "/docs/tools/" ] - [menu] [menu.tools] parent = "getting-started" diff --git a/web/content/docs/userguide/_index.md b/web/content/docs/userguide/_index.md new file mode 100644 index 0000000000000000000000000000000000000000..47ef805b4dacecdaa0f8af7b827f78008b64394e --- /dev/null +++ b/web/content/docs/userguide/_index.md @@ -0,0 +1,4 @@ ++++ +title = "User Guide" +first = "basics/introduction" ++++ diff --git a/web/layouts/section/docs.html b/web/layouts/section/docs.html index 96e49e826e347da1ecfc0cb6f41468d9a83f4f57..e0c63f1669ddda46eee18133ce5b49006e8eba66 100644 --- a/web/layouts/section/docs.html +++ b/web/layouts/section/docs.html @@ -2,7 +2,16 @@ <div class="container"> <h1>OpenGeoSys Documentation</h1> {{ .Content }} + + <!-- /docs/[subsection]/ --> + <h2>{{ .CurrentSection.Title }}</h2> + <ul> + {{ range .Pages }} + <li><a href="{{ .URL }}">{{ .Title }}</a></li> + {{ end }} + </ul> <div class="flex flex-wrap"> + <!-- /docs --> {{ range .Params.sections }} <div class="w-full sm:w-1/2 lg:w-1/3 p-3 my-3"> <h2 class="mb-2 text-center text-base md:text-lg lg:text-xl xl:text-2xl">