Fix documentation

piaste · Oct 21, 2016 · 182343c · 182343c
1 parent 90c7693
commit 182343c
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 21 deletions.
diff --git a/docs/content/index.fsx b/docs/content/index.fsx
@@ -36,26 +36,26 @@ group Romcyber
 </div>
 
 
-What are Suave and Swagger ?
+What are Suave and Swagger?
 ----------------------------
 
-- [Suave](https://suave.io/) is a FSharp lightweight web server principally used to develop REST APIs
+- [Suave](https://suave.io/) is a F# lightweight web server principally used to develop REST APIs
 - [Swagger](http://swagger.io/) is a usefull tool helping to create interactive documentation, client SDK generation and discoverability.
 
 
-Why using Swagger ?
+Why use Swagger?
 -------------------
 
-- To have beautiful interactive documentations.
-- To improve productivity during developments.
-- To give a possibility for API users to generate clients.
+- Generate beautiful API documentation, including a UI to explore and test operations.
+- Improve productivity during development.
+- Make it possible for API users to generate clients.
 
 
 Project
 -------
 
-This project is a [POC](https://en.wikipedia.org/wiki/Proof_of_concept) helping you to document your Suave services with Swagger.
-Swagger UI is embedded in resources and a webpart serving it is automatically added.
+This is a [proof of concept](https://en.wikipedia.org/wiki/Proof_of_concept) to document Suave web services with Swagger.
+[Swagger UI](http://swagger.io/swagger-ui/) is embedded in resources and a `WebPart` serving it is automatically added.
 
 
 ![Swagger UI 3](images/screen3.gif)

diff --git a/docs/content/rest.fsx b/docs/content/rest.fsx
@@ -48,7 +48,7 @@ let r2 = GET >=> path "/cat" >=> XML { Id=45; Name="category 45" }
 
 (**
 
-Allmost REST APIs response's format depends on "Accept" header sent in the request
+Most REST API response formats depend on "Accept" header sent in the request
 
 The MODEL helper will do it.
 

diff --git a/docs/content/tutorial.fsx b/docs/content/tutorial.fsx
@@ -66,7 +66,7 @@ let api1 =
   swagger {
     // syntax 1
     for route in getting (simpleUrl "/time" |> thenReturns now) do
-      yield description Of route is "What time is it ?"
+      yield description Of route is "What time is it?"
   }
 
 [<EntryPoint>]

diff --git a/examples/Suave.Swagger.PetStoreAPi/Program.fs b/examples/Suave.Swagger.PetStoreAPi/Program.fs
@@ -61,11 +61,11 @@ let api =
   swagger {
 //      // syntax 1
       for route in getting (simpleUrl "/time" |> thenReturns now) do
-        yield description Of route is "What time is it ?"
+        yield description Of route is "What time is it?"
 
 //      // another syntax
       for route in getOf (path "/time2" >=> now) do
-        yield description Of route is "What time is it 2 ?"
+        yield description Of route is "What time is it 2?"
         yield urlTemplate Of route is "/time2"
 
       for route in getting <| urlFormat "/subtract/%d/%d" subtract do

diff --git a/paket.template b/paket.template
@@ -6,7 +6,7 @@ authors
 owners
   rflechner
 description
-  This project is a POC helping you to document your Suave services with Swagger. Swagger UI is embedded in resources and a webpart serving it is automatically added.
+  This is a proof of concept to document Suave web services with Swagger. Swagger UI is embedded in resources and a WebPart serving it is automatically added.
 projectUrl
   http://github.com/rflechner/Suave.Swagger
 iconUrl

diff --git a/slides/index.fsx b/slides/index.fsx
@@ -23,18 +23,18 @@ Using Swagger with Suave
 
 ***
 
-## What are Suave and Swagger ?
+## What are Suave and Swagger?
 
-- [Suave](https://suave.io/) is a FSharp lightweight web server principally used to develop REST APIs
-- [Swagger](http://swagger.io/) is a usefull tool helping to create interactive documentation, client SDK generation and discoverability.
+- [Suave](https://suave.io/) is a F# lightweight web server principally used to develop REST APIs
+- [Swagger](http://swagger.io/) is a tool for creating interactive documentation, client SDK generation and discoverability.
 
 ***
 
-## Why using Swagger ?
+## Why use Swagger?
 
-- To have beautiful interactive documentations.
-- To improve productivity during developments.
-- To give a possibility for API users to generate clients.
+- Generate beautiful API documentation, including a UI to explore and test operations.
+- Improve productivity during development.
+- Make it possible for API users to generate clients.
 
 ***
 
@@ -104,7 +104,7 @@ let api1 =
   swagger {
     // syntax 1
     for route in getting (simpleUrl "/time" |> thenReturns now) do
-      yield description Of route is "What time is it ?"
+      yield description Of route is "What time is it?"
   }
 
 [<EntryPoint>]
-Original file line number
+Diff line change
@@ Expand Up @@
     (**
-    Allmost REST APIs response's format depends on "Accept" header sent in the request
+    Most REST API response formats depend on "Accept" header sent in the request
     The MODEL helper will do it.
@@ Expand Down @@