add images (#4)

codingdiaz · Sep 29, 2019 · 689d5d6 · 689d5d6
1 parent 42453e6
commit 689d5d6
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 A Github app that posts build logs from failed CircleCI jobs to Pull Requests.
 
 <p align="center">
-<img src="docs/docs/screenshot.png" alt="screenshot" height=60% width=60%>
+<img src="docs/docs/images/screenshot.png" alt="screenshot" height=60% width=60%>
 </p>
 
 For each pull request event, a webhook is sent to API Gateway, the request is authorized and ultimately an [AWS Step Function](https://aws.amazon.com/step-functions/) is started. The step function runs very simple logic with Lambda functions and uses step function features to run this as cheap as possible. 

diff --git a/docs/docs/architecture.md b/docs/docs/architecture.md
@@ -0,0 +1,6 @@
+# Architecture
+
+<img src="../images/diagram.png" alt="screenshot" height=60% width=60%>
+
+
+<img src="../images/step_func.png" alt="screenshot" height=60% width=60%>
diff --git a/docs/docs/images/diagram.png b/docs/docs/images/diagram.png
diff --git a/docs/docs/screenshot.png → docs/docs/images/screenshot.png b/docs/docs/screenshot.png → docs/docs/images/screenshot.png
diff --git a/docs/docs/images/step_func.png b/docs/docs/images/step_func.png
diff --git a/docs/docs/index.md b/docs/docs/index.md
@@ -3,7 +3,7 @@
 A Github app that posts build logs from failed CircleCI jobs to Pull Requests.
 
 <p align="center">
-<img src="screenshot.png" alt="screenshot" height=60% width=60%>
+<img src="images/screenshot.png" alt="screenshot" height=60% width=60%>
 </p>
 
 ## Overview

diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -3,4 +3,5 @@ docs_dir: docs
 theme:
   name: 'readthedocs'
 nav:
-    - 'Getting Started': 'getting_started.md'
+    - 'Getting Started': 'getting_started.md'
+    - 'Architecture': 'architecture.md'