tutorial: tweak some titles
commit23d6671c6c8705c2fe40ea4b17ee9a30b5bd326e
authorSönke Hahn <soenkehahn@gmail.com>
dateThu 18 Feb 2016, 18:13 (11 years ago)
parent9263f97
doc/index.rst+9−2
@@ -3,8 +3,15 @@ servant – A Type-Level Web DSL
33
44.. image:: https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png
55
6−Documentation table of contents
7−-------------------------------
6+``servant`` is a set of packages for writing web applications and tools around them.
7+It allows to
8+
9+- write servers,
10+- obtain clients (in haskell),
11+- generate client functions for other programming languages and
12+- generate documentation for your web applications.
13+
14+All in a type-safe manner.
815
916.. toctree::
1017 :maxdepth: 2
doc/links.rst+1−1
@@ -12,7 +12,7 @@ Helpful Links
1212 `https://github.com/haskell-servant/servant/issues <https://github.com/haskell-servant/servant/issues>`_
1313
1414- the irc channel:
15− #servant on freenode
15+ ``#servant`` on freenode
1616
1717- the mailing list:
1818 `groups.google.com/forum/#!forum/haskell-servant <https://groups.google.com/forum/#!forum/haskell-servant>`_
doc/tutorial/Client.lhs+1−1
@@ -1,4 +1,4 @@
1−# Deriving Haskell functions to query an API
1+# Querying an API
22
33While defining handlers that serve an API has a lot to it, querying an API is simpler: we do not care about what happens inside the webserver, we just need to know how to talk to it and get a response back. Except that we usually have to write the querying functions by hand because the structure of the API isn't a first class citizen and can't be inspected to generate a bunch of client-side functions.
44
doc/tutorial/Docs.lhs+1−1
@@ -1,4 +1,4 @@
1−# Generating documentation from API types
1+# Documenting an API
22
33The source for this tutorial section is a literate haskell file, so first we
44need to have some language extensions and imports:
doc/tutorial/Javascript.lhs+1−1
@@ -1,4 +1,4 @@
1−# Deriving Javascript functions to query an API
1+# Generating Javascript functions to query an API
22
33We will now see how *servant* lets you turn an API type into javascript
44functions that you can call to query a webservice. The derived code assumes you