Converted structure to markdown

bluesky · Jan 2, 2024 · e1ad99c · e1ad99c
1 parent d1c9266
commit e1ad99c
Show file tree

Hide file tree

Showing 9 changed files with 83 additions and 78 deletions.
diff --git a/docs/explanations.md b/docs/explanations.md
@@ -0,0 +1,15 @@
+---
+orphan: true
+---
+
+# Explanations
+
+Explanations of how it works and why it works that way.
+
+```{toctree}
+:maxdepth: 1
+
+explanations/technical-terms
+explanations/why-stack-frames
+explanations/why-squash-can-change-path
+```
diff --git a/docs/explanations.rst b/docs/explanations.rst
diff --git a/docs/how-to.md b/docs/how-to.md
@@ -0,0 +1,14 @@
+---
+orphan: true
+---
+
+# How-to Guides
+
+Practical step-by-step guides for the more experienced user.
+
+```{toctree}
+:maxdepth: 1
+
+how-to/iterate-a-spec
+how-to/serialize-a-spec
+```
diff --git a/docs/how-to.rst b/docs/how-to.rst
diff --git a/docs/index.md b/docs/index.md
@@ -1,3 +1,7 @@
+---
+html_theme.sidebar_secondary.remove: true
+---
+
 ```{include} ../README.md
 :end-before: <!-- README only content
 ```
@@ -16,41 +20,40 @@ top bar.
 ::::{grid} 2
 :gutter: 4
 
-:::{grid-item-card} {material-regular}`directions_walk;2em` Tutorials
-:link: tutorials
-:link-type: doc
+:::{grid-item-card} {material-regular}`directions_walk;2em` 
+```{toctree}
+:maxdepth: 2
 
+tutorials
+```
 Tutorials for installation and typical usage. New users start here.
 :::
 
-:::{grid-item-card} {material-regular}`directions;2em` How-to Guides
-:link: how-to
-:link-type: doc
+:::{grid-item-card} {material-regular}`directions;2em`
+```{toctree}
+:maxdepth: 2
 
+how-to
+```
 Practical step-by-step guides for the more experienced user.
 :::
 
-:::{grid-item-card} {material-regular}`info;2em` Explanations
-:link: explanations
-:link-type: doc
+:::{grid-item-card} {material-regular}`info;2em`
+```{toctree}
+:maxdepth: 2
 
+explanations
+```
 Explanations of how it works and why it works that way.
 :::
 
-:::{grid-item-card} {material-regular}`menu_book;2em` Reference
-:link: reference
-:link-type: doc
+:::{grid-item-card} {material-regular}`menu_book;2em`
+```{toctree}
+:maxdepth: 2
 
+reference
+```
 Technical reference material including APIs and release notes.
 :::
 
 ::::
-
-```{toctree}
-:hidden:
-
-tutorials
-how-to
-explanations
-reference
-```
diff --git a/docs/reference.md b/docs/reference.md
@@ -0,0 +1,19 @@
+---
+orphan: true
+---
+
+# Reference
+
+Technical reference material including APIs and release notes.
+
+```{toctree}
+:maxdepth: 1
+
+reference/api
+reference/rest_api
+reference/contributing
+Index <genindex.html#http://>
+```
+
+% Index link above is a hack to make genindex.html a relative link
+% https://stackoverflow.com/a/31820846
diff --git a/docs/reference.rst b/docs/reference.rst
diff --git a/docs/tutorials.md b/docs/tutorials.md
@@ -0,0 +1,11 @@
+# Tutorials
+
+Tutorials for installation and typical usage. New users start here.
+
+```{toctree}
+:maxdepth: 1
+
+tutorials/installation
+tutorials/creating-a-spec
+tutorials/rest-service
+```
diff --git a/docs/tutorials.rst b/docs/tutorials.rst