Merge pull request #1418 from apiaryio/honzajavorek/add-chart-source

Add chart source and document it
apiaryio · Jul 10, 2019 · 02f5776 · 02f5776
2 parents 2a828d8 + 2c09023
commit 02f5776
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/docs/_static/images/README.md b/docs/_static/images/README.md
@@ -0,0 +1,3 @@
+# Images directory
+
+Read more about the files here in Dredd's [internals docs](https://dredd.org/en/latest/internals.html#images).
diff --git a/docs/_static/images/hooks-handler.key b/docs/_static/images/hooks-handler.key
diff --git a/docs/internals.rst b/docs/internals.rst
@@ -291,6 +291,19 @@ Writing documentation
 -  Be consistent
 
 
+.. _images:
+
+Images
+~~~~~~
+
+Images are in the ``docs/_static/images`` directory. For images exported in sophisticated graphic formats, the source file should be committed to Git and placed in the same directory, with the same basename, just with different extension.
+
+.. note::
+    The ``.key`` files are not SSH keys, they're `Keynote <https://www.apple.com/keynote/>`__ source files. It is `@honzajavorek <https://github.com/honzajavorek>`__'s deviation to draw charts in Keynote and to export them as PNGs::
+
+        File » Export To » Images... » Format: PNG
+
+
 Sphinx extensions
 ~~~~~~~~~~~~~~~~~