Skip to content

Commit 1a60f2d

Browse files
committed
docs: add base FAQ
Add base FAQ.md file and include this in the Sphinx docs. Refs: #224
1 parent 93f2b4e commit 1a60f2d

File tree

3 files changed

+13
-0
lines changed

3 files changed

+13
-0
lines changed

FAQ.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Frequently Asked Questions
2+
=========================
3+
4+
This space is created to address common or important questions pertaining to Coreax.
5+
This will be reviewed for updates with each release of Coreax.

documentation/source/faq.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. _faq:
2+
3+
Frequently Asked Questions
4+
==========================
5+
6+
.. include:: ../../FAQ.md
7+
:parser: myst_parser.sphinx_

documentation/source/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,5 @@ Indices and tables
2020
* :ref:`genindex`
2121
* :ref:`modindex`
2222
* :ref:`search`
23+
* :ref:`faq`
2324
* :ref:`bibliography`

0 commit comments

Comments
 (0)