diagram in docs, thanks in readme (stoplightio#976)

* diagram in docs, thanks in readme * stoplight config * chore: reformat * docs: fix link Co-authored-by: Vincenzo Chianese <vincenz.chianese@icloud.com>
doraemoncito · Feb 11, 2020 · 1165bf1 · 1165bf1
1 parent 3266572
commit 1165bf1
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 2 deletions.
diff --git a/.stoplight.json b/.stoplight.json
@@ -0,0 +1,18 @@
+{
+  "formats": {
+    "openapi": {
+      "rootDir": "reference"
+    },
+    "markdown": {
+      "rootDir": "docs",
+      "include": ["**"]
+    },
+    "image": {
+      "rootDir": "assets/images",
+      "include": ["**"]
+    },
+    "json_schema": {
+      "rootDir": "models"
+    }
+  }
+}
diff --git a/README.md b/README.md
@@ -64,9 +64,21 @@ see what URLs you have available.
 
 If you are interested in contributing to Prism itself, check out our [contributing docs ⇗][contributing] and [code of conduct ⇗][code_of_conduct] to get started.
 
-## Prism Decision Flow Diagram
+## Thanks
 
-In case you're interested in all logical decision we make to figure out the best HTTP response to the specific request, you can consult our [diagram](./packages/http/docs/images/mock-server-dfd.png)
+Prism is built on top of lots of excellent packages, and here are a few we'd like to say a special thanks to.
+
+- [ajv](https://www.npmjs.com/package/ajv)
+- [faker](https://www.npmjs.com/package/faker)
+- [fp-ts](https://www.npmjs.com/package/fp-ts)
+- [gavel](https://www.npmjs.com/package/gavel)
+- [json-schema-faker](https://www.npmjs.com/package/json-schema-faker)
+- [lerna](https://www.npmjs.com/package/lerna)
+- [micri](https://www.npmjs.com/package/micri)
+- [openapi-sampler](https://www.npmjs.com/package/openapi-sampler)
+- [yargs](https://www.npmjs.com/package/yargs)
+
+Check these projects out!
 
 [code_of_conduct]: CODE_OF_CONDUCT.md
 [contributing]: CONTRIBUTING.md

diff --git a/docs/guides/01-mocking.md b/docs/guides/01-mocking.md
@@ -23,6 +23,12 @@ Prism will try to return meaningful responses based on whatever information it h
 The first thing to understand is that the Prism HTTP Server respects [Content Negotiation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Content_negotiation). If your API is a mixture of JSON, XML and form data, you can use `Accept`
 and `Content-Type` just like with a real API, and it should work as expected, or fail if you request non-existent types.
 
+### The "Decision Engine" 
+
+The response Prism decides to give can be figred out with this decision flow diagram.
+
+![](../../packages/http/docs/images/mock-server-dfd.png)
+
 ### Response Examples
 
 If a response has an example, it will be used for the response. If there are multiple examples then they can be selected by name. Let's take a look part of an OpenAPI description, this is an operation with a response that has a 200 OK and multiple examples: