140da7a · typeable/servant

git.iko.soy/typeable/servant

tutorial: tweaks

commit140da7a7b0311abd079f278239ba77a99a5bd94e authorSönke Hahn <soenkehahn@gmail.com> dateThu 18 Feb 2016, 22:12 (11 years ago) parent71a2140

3 files changed+10−12

compare with master

unifiedsplit

doc/index.rst+2−2 doc/introduction.rst+3−7 doc/tutorial/index.rst+5−3

doc/index.rst+2−2

@@ -3,10 +3,10 @@ servant – A Type-Level Web DSL

44.. image:: https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png

6−``servant`` is a set of packages for declaring web APIs at the type-level and

6+**servant** is a set of packages for declaring web APIs at the type-level and

77then using those API specifications to:

9−- write servers (this part of ``servant`` can be considered a web framework),

9+- write servers (this part of **servant** can be considered a web framework),

1010- obtain client functions (in haskell),

1111- generate client functions for other programming languages and

1212- generate documentation for your web applications.

doc/introduction.rst+3−7

@@ -1,7 +1,7 @@

11Introduction

22------------

4−*servant* has the following guiding principles:

4+**servant** has the following guiding principles:

66- concision

@@ -23,9 +23,9 @@ Introduction

2323- separation of concerns

2424

2525 Your handlers and your HTTP logic should be separate. True to the philosphy

26− at the core of HTTP and REST, with *servant* your handlers return normal

26+ at the core of HTTP and REST, with **servant** your handlers return normal

2727 Haskell datatypes - that's the resource. And then from a description of your

28− API, *servant* handles the *presentation* (i.e., the Content-Types). But

28+ API, **servant** handles the *presentation* (i.e., the Content-Types). But

2929 that's just one example.

3030

3131- type safety

@@ -38,7 +38,3 @@ might expect. The core idea is *reifying the description of your API*. Once

3838reified, everything follows. We think we might be the first web framework to

3939reify API descriptions in an extensible way. We're pretty sure we're the first

4040to reify it as *types*.

41−

42−To be able to write a webservice you only need to read the first two sections,

43−but the goal of this document being to get you started with servant, we also

44−cover the couple of ways you can extend servant for a great good.

doc/tutorial/index.rst+5−3

@@ -1,9 +1,11 @@

11Tutorial

22========

4−This is an introductory tutorial to the current version of *servant*, which is

5−**0.4**. Any comment or issue can be directed to `this website's issue

6−tracker <http://github.com/haskell-servant/haskell-servant.github.io/issues>`_.

4+This is an introductory tutorial to **servant**.

6+(Any comments, issues or feedback about the tutorial can be handled

7+through

8+`servant's issue tracker <http://github.com/haskell-servant/servant/issues>`_.)

810

911.. toctree::