[Doc] Add more stub pages to the Sphinx docs

Cantera · Oct 3, 2023 · 6a2e036 · 6a2e036
1 parent ac56e4c
commit 6a2e036
Show file tree

Hide file tree

Showing 5 changed files with 62 additions and 8 deletions.
diff --git a/doc/sphinx/reference/glossary.md b/doc/sphinx/reference/glossary.md
@@ -0,0 +1,7 @@
+# Glossary
+
+
+```{caution}
+This page is a work in progress. Please see
+<a href="/documentation/glossary.html">this page</a> for current documentation.
+```
diff --git a/doc/sphinx/reference/index.md b/doc/sphinx/reference/index.md
@@ -19,12 +19,6 @@ mechanism files.
 ````{grid} 2
 :gutter: 3
 
-```{grid-item-card} YAML Format Reference
-:link: /yaml/index
-:link-type: doc
-:text-align: center
-```
-
 ```{grid-item-card} Python API Reference
 :link: /python/index
 :link-type: doc
@@ -42,16 +36,29 @@ mechanism files.
 :text-align: center
 ```
 
+```{grid-item-card} YAML Format Reference
+:link: /yaml/index
+:link-type: doc
+:text-align: center
+```
+
+```{grid-item-card} Release Notes
+:link: releasenotes/index
+:link-type: doc
+:text-align: center
+```
+
 ````
 
 ```{toctree}
 :hidden:
 :maxdepth: 1
 :caption: API Reference
 
-/yaml/index
 /python/index
 /matlab/index
+/yaml/index
+releasenotes/index
 ```
 
 ## Science Reference
@@ -74,6 +81,12 @@ methods implemented by Cantera
 :text-align: center
 ```
 
+```{grid-item-card} Glossary
+:link: glossary
+:link-type: doc
+:text-align: center
+```
+
 ````
 
 ```{toctree}
@@ -83,4 +96,5 @@ methods implemented by Cantera
 
 science/reactors/index
 bibliography
+glossary
 ```
diff --git a/doc/sphinx/reference/releasenotes/index.md b/doc/sphinx/reference/releasenotes/index.md
@@ -0,0 +1,6 @@
+# Release Notes
+
+```{caution}
+This page is a work in progress. Please see
+<a href="/documentation/index.html">this page</a> for current documentation.
+```
diff --git a/doc/sphinx/userguide/faq.md b/doc/sphinx/userguide/faq.md
@@ -0,0 +1,11 @@
+# Frequently Asked Questions
+
+```{caution}
+This page is a work in progress. Sorry.
+```
+
+## Installation
+
+## Input Files
+* Where can I find chemical mechanisms to use with Cantera?
+* How do I fix errors converting Chemkin input files to Cantera's format?
diff --git a/doc/sphinx/userguide/index.md b/doc/sphinx/userguide/index.md
@@ -7,13 +7,29 @@ release (Cantera 3.0), please see <a href="/tutorials/index.html">this page</a>.
 
 ## Introductory Tutorials
 
+For those new to Cantera, we present here a set of short tutorials to familiarize you
+with Cantera's basic functionality and capabilities, give some examples of how to work
+Cantera within your preferred interface language, and demonstrate some basic
+troubleshooting.
 
 {doc}`Getting Started with Python <python-tutorial>`
 
-* Task/goal-oriented guides
+## Frequently asked questions
+
+See the {doc}`FAQ <faq>` for answers to some common issues that arise when using
+Cantera. If your question isn't answered here, consider asking us on the
+<a href="https://cantera.org/community.html#the-cantera-users-group">Cantera Users' Group</a>.
+
+## Task Guides
+
+The tutorials in this section are designed to help you accomplish a specific task
+using Cantera, such as evaluating the ignition delay time for a fuel under different
+conditions, or calculating the voltage of a Lithium-ion battery as it is discharged.
+
 
 ```{toctree}
 :hidden:
 
 python-tutorial
+faq
 ```