Add Screenshot for game-export API path

ajboni · Aug 19, 2023 · d25d437 · d25d437
1 parent 2d7afe1
commit d25d437
Show file tree

Hide file tree

Showing 26 changed files with 28 additions and 26 deletions.
diff --git a/build/en/docs/documentation/API_docs.html → build/en/docs/documentation/api_docs.html b/build/en/docs/documentation/API_docs.html → build/en/docs/documentation/api_docs.html
@@ -59,13 +59,13 @@
 
 <!-- Open Graph / Facebook -->
 <meta property="og:type" content="website">
-<meta property="og:url" content="https://drafft.aboni.dev/en/docs/documentation/API_docs.html">
+<meta property="og:url" content="https://drafft.aboni.dev/en/docs/documentation/api_docs.html">
 <meta property="og:title" content="Api Docs · Drafft">
 <meta property="og:description" content="Cross-platform collaborative and organized game development. Dialogue Tree Editor, GDDs Editor, Scripting Editor, and more...">
 
 <!-- Twitter -->
 <meta property="twitter:card" content="summary_large_image">
-<meta property="twitter:url" content="https://drafft.aboni.dev/en/docs/documentation/API_docs.html">
+<meta property="twitter:url" content="https://drafft.aboni.dev/en/docs/documentation/api_docs.html">
 <meta property="twitter:title" content="Api Docs · Drafft">
 <meta property="twitter:description" content="Cross-platform collaborative and organized game development. Dialogue Tree Editor, GDDs Editor, Scripting Editor, and more...">
 </head>
@@ -234,7 +234,7 @@
 </li>
 <!--  -->
 <li class="menu-item">
-  <a href="/en/docs/documentation/API_docs.html">
+  <a href="/en/docs/documentation/api_docs.html">
     <strong> Api Docs  </strong></a>
 </li>
 <!--  -->
@@ -269,6 +269,7 @@ <h3 id="get-game-export" tabindex="-1">Get Game Export <a class="header-anchor"
 <p>Accepted Values: <code>ProjectSettings</code> <code>GDD</code> <code>Scripts</code> <code>Actors</code> <code>Quests</code> <code>Items</code> <code>Misc</code> <code>Grids</code> <code>Kanban</code></p>
 <pre class="hljs"><label class="language-caption"></label><code>GET /game-export?collections=Scripts,Items,Actors
 </code></pre>
+<p><img src="/img/api-game-export.png" alt=""></p>
 <h3 id="get-database-dump" tabindex="-1">Get Database Dump <a class="header-anchor" href="#get-database-dump">¶</a></h3>
 <p>Gets a database dump directly from the PouchDB instance. It accepts any <a href="https://pouchdb.com/api.html#batch_fetch">PouchDB allDocs options</a>.
 Default options are <code>include_docs: true</code> and <code>options.attachments: true</code></p>

diff --git a/build/en/docs/documentation/exporting.html b/build/en/docs/documentation/exporting.html
@@ -234,7 +234,7 @@
 </li>
 <!--  -->
 <li class="menu-item">
-  <a href="/en/docs/documentation/API_docs.html">
+  <a href="/en/docs/documentation/api_docs.html">
      Api Docs </a>
 </li>
 <!--  -->

diff --git a/build/en/docs/documentation/multiuser.html b/build/en/docs/documentation/multiuser.html
@@ -234,7 +234,7 @@
 </li>
 <!--  -->
 <li class="menu-item">
-  <a href="/en/docs/documentation/API_docs.html">
+  <a href="/en/docs/documentation/api_docs.html">
      Api Docs </a>
 </li>
 <!--  -->

diff --git a/build/en/docs/documentation/quick_start.html b/build/en/docs/documentation/quick_start.html
@@ -234,7 +234,7 @@
 </li>
 <!--  -->
 <li class="menu-item">
-  <a href="/en/docs/documentation/API_docs.html">
+  <a href="/en/docs/documentation/api_docs.html">
      Api Docs </a>
 </li>
 <!--  -->

diff --git a/build/en/docs/documentation/screenplay_generation.html b/build/en/docs/documentation/screenplay_generation.html
@@ -234,7 +234,7 @@
 </li>
 <!--  -->
 <li class="menu-item">
-  <a href="/en/docs/documentation/API_docs.html">
+  <a href="/en/docs/documentation/api_docs.html">
      Api Docs </a>
 </li>
 <!--  -->
@@ -277,7 +277,7 @@ <h2 id="special-commands" tabindex="-1">Special Commands <a class="header-anchor
           <!-- Docs content HERE (id='docs-content-container') -->
           <nav id="next-prev-container" class="next-prev-container">
             <!-- Next Previous buttons here -->
-          <div class="prevBtn"><a class="btn-link btn-action" href="/en/docs/documentation/exporting.html" aria-label="Previous document"> <i class="icon icon-back"> </i> Previous: Exporting</a></div><div class="nextBtn"><a class="btn-link btn-action" href="/en/docs/documentation/API_docs.html" aria-label="Previous document">Next: Api Docs <i class="icon icon-forward"></i></a></div></nav>
+          <div class="prevBtn"><a class="btn-link btn-action" href="/en/docs/documentation/exporting.html" aria-label="Previous document"> <i class="icon icon-back"> </i> Previous: Exporting</a></div><div class="nextBtn"><a class="btn-link btn-action" href="/en/docs/documentation/api_docs.html" aria-label="Previous document">Next: Api Docs <i class="icon icon-forward"></i></a></div></nav>
           <!-- Footer -->
           <footer class="docs-footer" id="footer-container"><p>
   Powered by

diff --git a/build/en/docs/documentation/scripting.html b/build/en/docs/documentation/scripting.html
@@ -234,7 +234,7 @@
 </li>
 <!--  -->
 <li class="menu-item">
-  <a href="/en/docs/documentation/API_docs.html">
+  <a href="/en/docs/documentation/api_docs.html">
      Api Docs </a>
 </li>
 <!--  -->

diff --git a/build/en/docs/download_from_itchio copy.html b/build/en/docs/download_from_itchio copy.html
@@ -234,7 +234,7 @@
 </li>
 <!--  -->
 <li class="menu-item">
-  <a href="/en/docs/documentation/API_docs.html">
+  <a href="/en/docs/documentation/api_docs.html">
      Api Docs </a>
 </li>
 <!--  -->

diff --git a/build/en/docs/features/development.html b/build/en/docs/features/development.html
@@ -234,7 +234,7 @@
 </li>
 <!--  -->
 <li class="menu-item">
-  <a href="/en/docs/documentation/API_docs.html">
+  <a href="/en/docs/documentation/api_docs.html">
      Api Docs </a>
 </li>
 <!--  -->

diff --git a/build/en/docs/features/dialogue_tree_editor.html b/build/en/docs/features/dialogue_tree_editor.html
@@ -236,7 +236,7 @@
 </li>
 <!--  -->
 <li class="menu-item">
-  <a href="/en/docs/documentation/API_docs.html">
+  <a href="/en/docs/documentation/api_docs.html">
      Api Docs </a>
 </li>
 <!--  -->

diff --git a/build/en/docs/features/director-module.html b/build/en/docs/features/director-module.html
@@ -236,7 +236,7 @@
 </li>
 <!--  -->
 <li class="menu-item">
-  <a href="/en/docs/documentation/API_docs.html">
+  <a href="/en/docs/documentation/api_docs.html">
      Api Docs </a>
 </li>
 <!--  -->

diff --git a/build/en/docs/features/export-mappings.html b/build/en/docs/features/export-mappings.html
@@ -236,7 +236,7 @@
 </li>
 <!--  -->
 <li class="menu-item">
-  <a href="/en/docs/documentation/API_docs.html">
+  <a href="/en/docs/documentation/api_docs.html">
      Api Docs </a>
 </li>
 <!--  -->

diff --git a/build/en/docs/features/game_design_document.html b/build/en/docs/features/game_design_document.html
@@ -236,7 +236,7 @@
 </li>
 <!--  -->
 <li class="menu-item">
-  <a href="/en/docs/documentation/API_docs.html">
+  <a href="/en/docs/documentation/api_docs.html">
      Api Docs </a>
 </li>
 <!--  -->

diff --git a/build/en/docs/features/grids_database.html b/build/en/docs/features/grids_database.html
@@ -234,7 +234,7 @@
 </li>
 <!--  -->
 <li class="menu-item">
-  <a href="/en/docs/documentation/API_docs.html">
+  <a href="/en/docs/documentation/api_docs.html">
      Api Docs </a>
 </li>
 <!--  -->

diff --git a/build/en/docs/features/items_database.html b/build/en/docs/features/items_database.html
@@ -234,7 +234,7 @@
 </li>
 <!--  -->
 <li class="menu-item">
-  <a href="/en/docs/documentation/API_docs.html">
+  <a href="/en/docs/documentation/api_docs.html">
      Api Docs </a>
 </li>
 <!--  -->

diff --git a/build/en/docs/features/kanban_boards.html b/build/en/docs/features/kanban_boards.html
@@ -236,7 +236,7 @@
 </li>
 <!--  -->
 <li class="menu-item">
-  <a href="/en/docs/documentation/API_docs.html">
+  <a href="/en/docs/documentation/api_docs.html">
      Api Docs </a>
 </li>
 <!--  -->

diff --git a/build/en/docs/features/misc_database.html b/build/en/docs/features/misc_database.html
@@ -234,7 +234,7 @@
 </li>
 <!--  -->
 <li class="menu-item">
-  <a href="/en/docs/documentation/API_docs.html">
+  <a href="/en/docs/documentation/api_docs.html">
      Api Docs </a>
 </li>
 <!--  -->

diff --git a/build/en/docs/features/multi-user.html b/build/en/docs/features/multi-user.html
@@ -234,7 +234,7 @@
 </li>
 <!--  -->
 <li class="menu-item">
-  <a href="/en/docs/documentation/API_docs.html">
+  <a href="/en/docs/documentation/api_docs.html">
      Api Docs </a>
 </li>
 <!--  -->

diff --git a/build/en/docs/features/quests.html b/build/en/docs/features/quests.html
@@ -236,7 +236,7 @@
 </li>
 <!--  -->
 <li class="menu-item">
-  <a href="/en/docs/documentation/API_docs.html">
+  <a href="/en/docs/documentation/api_docs.html">
      Api Docs </a>
 </li>
 <!--  -->

diff --git a/build/en/docs/features/script_editor.html b/build/en/docs/features/script_editor.html
@@ -236,7 +236,7 @@
 </li>
 <!--  -->
 <li class="menu-item">
-  <a href="/en/docs/documentation/API_docs.html">
+  <a href="/en/docs/documentation/api_docs.html">
      Api Docs </a>
 </li>
 <!--  -->

diff --git a/build/en/docs/forums.html b/build/en/docs/forums.html
@@ -234,7 +234,7 @@
 </li>
 <!--  -->
 <li class="menu-item">
-  <a href="/en/docs/documentation/API_docs.html">
+  <a href="/en/docs/documentation/api_docs.html">
      Api Docs </a>
 </li>
 <!--  -->

diff --git a/build/en/docs/index.html b/build/en/docs/index.html
@@ -236,7 +236,7 @@
 </li>
 <!--  -->
 <li class="menu-item">
-  <a href="/en/docs/documentation/API_docs.html">
+  <a href="/en/docs/documentation/api_docs.html">
      Api Docs </a>
 </li>
 <!--  -->

diff --git a/build/en/searchDatabase.json b/build/en/searchDatabase.json
diff --git a/build/en/searchIndex.json b/build/en/searchIndex.json
diff --git a/build/img/api-game-export.png b/build/img/api-game-export.png
diff --git a/...en/docs/05__documentation/07__API_docs.md → ...en/docs/05__documentation/07__api_docs.md b/...en/docs/05__documentation/07__API_docs.md → ...en/docs/05__documentation/07__api_docs.md
@@ -30,6 +30,7 @@ Accepted Values: `ProjectSettings` `GDD` `Scripts` `Actors` `Quests` `Items` `Mi
 GET /game-export?collections=Scripts,Items,Actors
 ```
 
+![](/img/api-game-export.png)
 ### Get Database Dump
 
 Gets a database dump directly from the PouchDB instance. It accepts any [PouchDB allDocs options](https://pouchdb.com/api.html#batch_fetch).

diff --git a/content/img/api-game-export.png b/content/img/api-game-export.png