diff --git a/doc/index.rst b/doc/index.rst index 9757ec1b..b1e24c99 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -3,8 +3,15 @@ servant – A Type-Level Web DSL .. image:: https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png -Documentation table of contents -------------------------------- +``servant`` is a set of packages for writing web applications and tools around them. +It allows to + +- write servers, +- obtain clients (in haskell), +- generate client functions for other programming languages and +- generate documentation for your web applications. + +All in a type-safe manner. .. toctree:: :maxdepth: 2 diff --git a/doc/links.rst b/doc/links.rst index 8f28d16f..5f14c527 100644 --- a/doc/links.rst +++ b/doc/links.rst @@ -12,7 +12,7 @@ Helpful Links `https://github.com/haskell-servant/servant/issues `_ - the irc channel: - #servant on freenode + ``#servant`` on freenode - the mailing list: `groups.google.com/forum/#!forum/haskell-servant `_ diff --git a/doc/tutorial/Client.lhs b/doc/tutorial/Client.lhs index 60dc88e4..201f187d 100644 --- a/doc/tutorial/Client.lhs +++ b/doc/tutorial/Client.lhs @@ -1,4 +1,4 @@ -# Deriving Haskell functions to query an API +# Querying an API While 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. diff --git a/doc/tutorial/Docs.lhs b/doc/tutorial/Docs.lhs index adc63924..b1edc38e 100644 --- a/doc/tutorial/Docs.lhs +++ b/doc/tutorial/Docs.lhs @@ -1,4 +1,4 @@ -# Generating documentation from API types +# Documenting an API The source for this tutorial section is a literate haskell file, so first we need to have some language extensions and imports: diff --git a/doc/tutorial/Javascript.lhs b/doc/tutorial/Javascript.lhs index c5f118b1..85d16e20 100644 --- a/doc/tutorial/Javascript.lhs +++ b/doc/tutorial/Javascript.lhs @@ -1,4 +1,4 @@ -# Deriving Javascript functions to query an API +# Generating Javascript functions to query an API We will now see how *servant* lets you turn an API type into javascript functions that you can call to query a webservice. The derived code assumes you