Created FAQ

appliedfm · Nov 29, 2021 · 101ae21 · 101ae21
1 parent 913770c
commit 101ae21
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 33 deletions.
diff --git a/docs/source/alectryon_examples.rst b/docs/source/alectryon_examples.rst
diff --git a/docs/source/faq.rst b/docs/source/faq.rst
@@ -0,0 +1,41 @@
+FAQ
+===
+
+
+Why adopt a style guide?
+------------------------
+
+TODO
+
+
+When is the right time to adopt a style guide?
+----------------------------------------------
+
+TODO
+
+
+Why adopt *this* style guide?
+-----------------------------
+
+TODO
+
+
+What is Alectryon?
+------------------
+
+`Alectryon <https://github.com/cpitclaudel/alectryon/>`_ is a tool for processing Coq files and generating pretty output for use in HTML, PDF, and other formats.
+
+When used to generate HTML, it allows readers to step-through the intermediate goal states of proofs using :command:`ctrl+↓` and :command:`ctrl+↑` or by hovering the mouse cursor over a particular line. Try it now:
+
+.. coq::
+
+   Lemma le_l : forall y x, S x <= y -> x <= y.
+     induction y; inversion 1; subst.
+     all: info_eauto.
+   Qed.
+
+
+How can I contribute to this guide?
+-----------------------------------
+
+`vstyle is hosted on GitHub <https://github.com/appliedfm/vstyle>`_. Information about how to contribute can be found in `our CONTRIBUTING.md file <https://github.com/appliedfm/vstyle/blob/main/CONTRIBUTING.md>`_.
diff --git a/docs/source/alectryon_examples.rst.cache → docs/source/faq.rst.cache b/docs/source/alectryon_examples.rst.cache → docs/source/faq.rst.cache
@@ -11,7 +11,7 @@
       "sertop_args": []
     },
     "chunks": [
-      "Lemma le_l : forall y x, S x <= y -> x <= y.\n  induction y; inversion 1; subst.\n  all: info_eauto.\nQed."
+      "Lemma le_l : forall y x, S x <= y -> x <= y.\n  induction y; inversion 1; subst.\n  all: info_eauto.\nQed.\n"
     ],
     "annotated": [
       [
@@ -165,6 +165,10 @@
           "contents": "Qed.",
           "messages": [],
           "goals": []
+        },
+        {
+          "_type": "text",
+          "contents": "\n"
         }
       ]
     ]

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -13,7 +13,7 @@ About
    :maxdepth: 3
 
    principles
-   alectryon_examples
+   faq
 
 
 Code Style