From cf4af0143e5f6a2db48e76681e382408cf7988ea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6nke=20Hahn?= Date: Thu, 18 Feb 2016 22:12:27 +0100 Subject: [PATCH] tutorial: tweaks --- doc/index.rst | 4 ++-- doc/introduction.rst | 10 +++------- doc/tutorial/index.rst | 8 +++++--- 3 files changed, 10 insertions(+), 12 deletions(-) diff --git a/doc/index.rst b/doc/index.rst index 2f300a1f..2c44df0a 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -3,10 +3,10 @@ servant – A Type-Level Web DSL .. image:: https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png -``servant`` is a set of packages for declaring web APIs at the type-level and +**servant** is a set of packages for declaring web APIs at the type-level and then using those API specifications to: -- write servers (this part of ``servant`` can be considered a web framework), +- write servers (this part of **servant** can be considered a web framework), - obtain client functions (in haskell), - generate client functions for other programming languages and - generate documentation for your web applications. diff --git a/doc/introduction.rst b/doc/introduction.rst index 6c5050bc..77ef306b 100644 --- a/doc/introduction.rst +++ b/doc/introduction.rst @@ -1,7 +1,7 @@ Introduction ------------ -*servant* has the following guiding principles: +**servant** has the following guiding principles: - concision @@ -23,9 +23,9 @@ Introduction - separation of concerns Your handlers and your HTTP logic should be separate. True to the philosphy - at the core of HTTP and REST, with *servant* your handlers return normal + at the core of HTTP and REST, with **servant** your handlers return normal Haskell datatypes - that's the resource. And then from a description of your - API, *servant* handles the *presentation* (i.e., the Content-Types). But + API, **servant** handles the *presentation* (i.e., the Content-Types). But that's just one example. - type safety @@ -38,7 +38,3 @@ might expect. The core idea is *reifying the description of your API*. Once reified, everything follows. We think we might be the first web framework to reify API descriptions in an extensible way. We're pretty sure we're the first to reify it as *types*. - -To be able to write a webservice you only need to read the first two sections, -but the goal of this document being to get you started with servant, we also -cover the couple of ways you can extend servant for a great good. diff --git a/doc/tutorial/index.rst b/doc/tutorial/index.rst index 37dab25f..cf2cfd8e 100644 --- a/doc/tutorial/index.rst +++ b/doc/tutorial/index.rst @@ -1,9 +1,11 @@ Tutorial ======== -This is an introductory tutorial to the current version of *servant*, which is -**0.4**. Any comment or issue can be directed to `this website's issue -tracker `_. +This is an introductory tutorial to **servant**. + +(Any comments, issues or feedback about the tutorial can be handled +through +`servant's issue tracker `_.) .. toctree::