Merge pull request #108 from SettleAPI/stage

Stage

Author: iamchriswick

README.md

@@ -43,11 +43,11 @@ At its core, **Netlify CMS** is an open-source React app that acts as a wrapper
 
 1. ### Clone this repo
 
-   `git clone https://github.com/SettleForDevelopers/Developer-Docs.git`
+   `git clone https://github.com/SettleAPI/settle-developer-docs.git`
 
 2. ### Navigate into your newly created Settle API docs directory
 
-   `cd settle-api-docs`
+   `cd settle-developer-docs`
 
 3. ### Install dependencies
 

docs/.vuepress/config.js

@@ -202,6 +202,7 @@ module.exports = (ctx) => ({
     '.vuepress/nav/top/mainNav.js',
     // Sidebars
     '.vuepress/nav/sidebars.js',
+    '.vuepress/nav/left/guides.js',
     '.vuepress/nav/left/rest/rest.js',
     '.vuepress/nav/left/rest/v1/summary.js',
     '.vuepress/nav/left/rest/v1/resources.js',

docs/.vuepress/enhanceApp.js

@@ -1,3 +1 @@
-module.exports = () => {
-    // console.log('enhancedApp.js');
-}
+

docs/.vuepress/nav/left/guides.js

@@ -1,39 +1,49 @@
-const introduction = require('./guides/introduction.js');
+// const introduction = require('./guides/introduction.js');
 const quickstarts = require('./guides/quickstarts.js');
 const tutorials = require('./guides/tutorials.js');
 const best_practices = require('./guides/best-practices.js');
 
-
 const overview = {
-    title: 'Overview',
-    collapsable: false,
-    sidebarDepth: 0,
-    children: [
-        ['/api/guides/', 'Settle API Overview'],
-    ],
-}
-
-module.exports = [
-    overview,
-    introduction,
-    quickstarts,
-    tutorials,
-    best_practices,
-]
+  title: 'Overview',
+  collapsable: false,
+  sidebarDepth: 0,
+  children: [['/api/guides/', 'Settle API Overview']],
+};
 
+/**
+ * @todo #96 @rexgnu Edit the Introductions Sidabar here. Documents are found in '/docs/api/guides/introduction'.
+ */
+const introduction = {
+  title: 'Introduction', // required
+  collapsable: false,
+  sidebarDepth: 0,
+  children: [
+    ['/api/guides/introduction/a-note-on-settle-api-users.md', 'A Note on Settle API Users'],
+    ['/api/guides/introduction/attachments.md','Attachments'],
+    ['/api/guides/introduction/authentication.md','Authentication'],
+    ['/api/guides/introduction/callbacks.md','Callbacks'],
+    ['/api/guides/introduction/error-responses.md','Error Responses'],
+    ['/api/guides/introduction/interacting.md','Interacting'],
+    ['/api/guides/introduction/ledgers.md','Ledgers'],
+    ['/api/guides/introduction/media-type.md','Media Types'],
+    ['/api/guides/introduction/payment-flows.md','Payment Flows'],
+    ['/api/guides/introduction/permission-requests.md','Permission Requests'],
+    ['/api/guides/introduction/qr-acceptance.md','QR Acceptance'],
+    ['/api/guides/introduction/resiliency.md','Resiliency'],
+    ['/api/guides/introduction/sandbox-environment.md','Sandbox Enviroment #1'],
+    ['/api/guides/introduction/settle-sandbox-environment.md',' Sandbox Enviroment #2'],
+    ['/api/guides/introduction/settlements.md','Settlements'],
+    ['/api/guides/introduction/versioning.md','Verioning'],
+  ],
+};
 
-// function getIntroductionSidebar() {
-//     return [
-//         '/introduction/',
-//         '/introduction/interacting',
-//         '/introduction/callbacks',
-//         '/introduction/error-responses',
-//         '/introduction/media-type',
-//         '/introduction/a-note-on-settle-api-users',
-//         '/introduction/versioning',
-//         ['/introduction/resiliency', 'Resiliency'],
-//     ];
-// }
+module.exports = [
+  overview,
+  introduction,
+  // quickstarts,
+  tutorials,
+  //   best_practices,
+];
 
 // function getGuidesSidebar() {
 //     return [
@@ -46,4 +56,7 @@ module.exports = [
 //         '/guides/permission-requests',
 //         '/guides/qr-acceptance',
 //     ];
-// }
+// }
+ 
+
+

docs/.vuepress/nav/left/rest/v1/reference/merchant.js

@@ -6,6 +6,7 @@ function merchant_apiKeys() {
     children: [
       ['/api/reference/rest/v1/merchant.apiKeys/', 'Overview'],
       ['/api/reference/rest/v1/merchant.apiKeys/create', 'create'],
+      ['/api/reference/rest/v1/merchant.apiKeys/list', 'list'],
       ['/api/reference/rest/v1/merchant.apiKeys/get', 'get'],
       ['/api/reference/rest/v1/merchant.apiKeys/update', 'update'],
       ['/api/reference/rest/v1/merchant.apiKeys/delete', 'delete'],

docs/.vuepress/theme/components/Models.vue

@@ -19,7 +19,7 @@
             <!-- <a :href="'#' + type.title" class="header-anchor">#</a>  -->
             {{ type.title }}
           </h2>
-          <p v-if="type.properties && type.description">
+          <p v-if="type.properties || type.description">
             {{ type.description }}
           </p>
           <div v-if="type.properties" class="modelEntry">
@@ -112,7 +112,7 @@
               <p v-if="property.description">{{ property.description }}</p>
             </div>
           </div>
-          <div v-else>
+          <div v-if="!type.description && !type.properties">
             <p>
               No info available for <strong>{{ type.title }}</strong> at of this
               moment. Please
@@ -187,7 +187,7 @@ export default {
     } else if (site.pages[0].models) {
       data.types = site.pages[0].models;
     } else {
-      console.warn('Neither page.models or site.pages[0].models found...');
+      console.warn("Neither page.models or site.pages[0].models found...");
     }
 
     // console.log(data.types);

docs/.vuepress/theme/components/PageReference.vue

@@ -68,14 +68,10 @@
         The above services has the following endpoints (resources), and all
         methods below are relative to its parent method (service endpoint).
       </p>
-      <div class="md-api_reference_FiraCode">
+      <div class="md-api_reference_FiraCode" v-if="!resource.internal">
         <!-- REST REsources -->
 
-        <section
-          v-if="!resource.internal"
-          v-for="(resource, index) in $data.resource"
-          :key="index"
-        >
+        <section v-for="(resource, index) in $data.resource" :key="index">
           <h3 :id="'v' + resource.version + '-' + resource.headerAnchor">
             <router-link
               :to="'#v' + resource.version + '-' + resource.headerAnchor"