git.iko.soy/typeable/servant
on master help sign in
tutorial: tweak some titles
23d6671Sönke Hahn
doc/index.rst+9−2
compare with master
unifiedsplit
@@ -3,8 +3,15 @@ servant – A Type-Level Web DSL
3
3
4.. image:: https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png
4.. image:: https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png
5
5
6−Documentation table of contents
6+``servant`` is a set of packages for writing web applications and tools around them.
7−-------------------------------
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.
8
15
9.. toctree::
16.. toctree::
10 :maxdepth: 2
17 :maxdepth: 2
doc/links.rst+1−1
@@ -12,7 +12,7 @@ Helpful Links
12 `https://github.com/haskell-servant/servant/issues <https://github.com/haskell-servant/servant/issues>`_
12 `https://github.com/haskell-servant/servant/issues <https://github.com/haskell-servant/servant/issues>`_
13
13
14- the irc channel:
14- the irc channel:
15− #servant on freenode
15+ ``#servant`` on freenode
16
16
17- the mailing list:
17- the mailing list:
18 `groups.google.com/forum/#!forum/haskell-servant <https://groups.google.com/forum/#!forum/haskell-servant>`_
18 `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
2
2
3While 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.
3While 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.
4
4
doc/tutorial/Docs.lhs+1−1
@@ -1,4 +1,4 @@
1−# Generating documentation from API types
1+# Documenting an API
2
2
3The source for this tutorial section is a literate haskell file, so first we
3The source for this tutorial section is a literate haskell file, so first we
4need to have some language extensions and imports:
4need 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
2
2
3We will now see how *servant* lets you turn an API type into javascript
3We will now see how *servant* lets you turn an API type into javascript
4functions that you can call to query a webservice. The derived code assumes you
4functions that you can call to query a webservice. The derived code assumes you