Adress comments

GeodynamicWorldBuilder · Feb 13, 2024 · 8ddab11 · 8ddab11
1 parent 289efab
commit 8ddab11
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/...tesian_rift/1000K_temperature_contour.png → ...an_rift/doc/1000K_temperature_contour.png b/...tesian_rift/1000K_temperature_contour.png → ...an_rift/doc/1000K_temperature_contour.png
diff --git a/cookbooks/3d_cartesian_rift/README.md → cookbooks/3d_cartesian_rift/doc/README.md b/cookbooks/3d_cartesian_rift/README.md → cookbooks/3d_cartesian_rift/doc/README.md
@@ -5,9 +5,9 @@
 A simple setup of a rift in a Cartesian box, in which two plates are spreading at a constant spreading rate.
 The files can be found [here](https://github.com/GeodynamicWorldBuilder/WorldBuilder/tree/main/cookbooks/3d_cartesian_rift).
 
-The relevant part of the world builder file looks like this:
+The relevant part of the World Builder file looks like this:
 
-:::{literalinclude} 3d_cartesian_rift.wb
+:::{literalinclude} ../3d_cartesian_rift.wb
 :language: json
 :lineno-start: 1
 :::

diff --git a/cookbooks/index.md b/cookbooks/index.md
@@ -2,10 +2,11 @@
 Cookbooks
 ======================
 
-This section contains self contained cookbooks on how to design different geodynamic setups. Folders contain World Builder parameter files, grid output files, and optionally markdown files that are incorporated into the online documentation and explain particular features about the setup.
+This section contains self-contained cookbooks on how to design different geodynamic setups. Cookbook folders contain World Builder parameter files, grid output files, and optionally a documentation folder called `doc`. The documentation folder contains markdown files and figures, which are incorporated into the online documentation and explain particular features about the cookbook.
 
 
 ```{toctree}
+: hidden:
 
-3d_cartesian_rift/README
+3d_cartesian_rift/doc/README
 ```