git.iko.soy/typeable/servant
on master help sign in
tutorial: tweaks
140da7aSönke Hahn
doc/index.rst+2−2
compare with master
unifiedsplit
@@ -3,10 +3,10 @@ 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−``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
7then using those API specifications to:
7then using those API specifications to:
8
8
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),
10- obtain client functions (in haskell),
10- obtain client functions (in haskell),
11- generate client functions for other programming languages and
11- generate client functions for other programming languages and
12- generate documentation for your web applications.
12- generate documentation for your web applications.
doc/introduction.rst+3−7
@@ -1,7 +1,7 @@
1Introduction
1Introduction
2------------
2------------
3
3
4−*servant* has the following guiding principles:
4+**servant** has the following guiding principles:
5
5
6- concision
6- concision
7
7
@@ -23,9 +23,9 @@ Introduction
23- separation of concerns
23- separation of concerns
24
24
25 Your handlers and your HTTP logic should be separate. True to the philosphy
25 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
27 Haskell datatypes - that's the resource. And then from a description of your
27 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
29 that's just one example.
29 that's just one example.
30
30
31- type safety
31- type safety
@@ -38,7 +38,3 @@ might expect. The core idea is *reifying the description of your API*. Once
38reified, everything follows. We think we might be the first web framework to
38reified, everything follows. We think we might be the first web framework to
39reify API descriptions in an extensible way. We're pretty sure we're the first
39reify API descriptions in an extensible way. We're pretty sure we're the first
40to reify it as *types*.
40to 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 @@
1Tutorial
1Tutorial
2========
2========
3
3
4−This is an introductory tutorial to the current version of *servant*, which is
4+This is an introductory tutorial to **servant**.
5−**0.4**. Any comment or issue can be directed to `this website's issue
5+
6+(Any comments, issues or feedback about the tutorial can be handled
7+through
6−tracker <http://github.com/haskell-servant/haskell-servant.github.io/issues>`_.
8+`servant's issue tracker <http://github.com/haskell-servant/servant/issues>`_.)
7
9
8
10
9.. toctree::
11.. toctree::