FAQs.

Author: Lukasa

docs/source/faq.rst

@@ -0,0 +1,55 @@
+.. _faq:
+
+Frequently Asked Questions
+==========================
+
+``hyper`` is a project that's under active development, and is in early alpha.
+As a result, there are plenty of rough edges and bugs. This section of the
+documentation attempts to address some of your likely questions.
+
+If you find there is no answer to your question in this list, please send me
+an email. My email address can be found `on my GitHub profile page`_.
+
+.. _on my GitHub profile page: https://github.com/Lukasa
+
+What version of the HTTP/2.0 draft specification does ``hyper`` support?
+------------------------------------------------------------------------
+
+Currently, ``hyper`` supports version 9 of the HTTP/2.0 draft specification,
+and version 5 of the HPACK draft specification. ``hyper`` will be updated to
+keep up with the HTTP/2.0 draft specifications as they progress.
+
+Does ``hyper`` support HTTP/2.0 flow control?
+---------------------------------------------
+
+It should! If you find it doesn't, that's a bug: please report it on GitHub.
+
+Does ``hyper`` support Server Push?
+-----------------------------------
+
+No, and I don't think it ever will directly. Support for Server Push
+effectively *mandates* a multithreaded or event-loop based programming style,
+which is incompatible with most current Python HTTP code. For that reason,
+``hyper``'s default API is unlikely to ever allow Server Push.
+
+However, there's no reason the underlying framing and stream layers couldn't
+support it. If ``hyper`` ever grows a server implementation or a fully
+event-loop based implementation, I'll revisit the decision not to support
+Server Push.
+
+I hit a bug! What should I do?
+------------------------------
+
+Please tell me about it using the GitHub page for the project, here_, by filing
+an issue. There will definitely be bugs as ``hyper`` is very new, and reporting
+them is the fastest way to get them fixed.
+
+When you report them, please follow the contribution guidelines in the README.
+It'll make it a lot easier for me to fix the problem.
+
+.. _here: https://github.com/Lukasa/hyper
+
+Updates
+-------
+
+Further questions will be added here over time. Please check back regularly.

docs/source/index.rst

@@ -45,6 +45,16 @@ The quickstart documentation will help get you going with ``hyper``.
 
    quickstart
 
+Frequently Asked Questions
+--------------------------
+
+Got a question? I might have answered it already! Take a look.
+
+.. toctree::
+   :maxdepth: 2
+
+   faq
+
 API Documentation
 -----------------