Merge branch 'main' of https://github.com/terminusdb/terminusdb-client-js

Author: Francesca-Bit

.github/workflows/ci.yml

@@ -42,13 +42,6 @@ jobs:
         npm run test:integration
     - name: Lint
       run: npm run lint:check
-    - name: Check for changes to docs
-      run: npm run mkdocs
-    - name: Auto commit docs changes if any
-      uses: stefanzweifel/git-auto-commit-action@v4
-      with:
-        commit_message: Apply docs changes
-        file_pattern: docs/api/*.md
     - name: Genrate test coverage report
       run: npm run coveralls-after
     - name: Update coveralls

.github/workflows/docs.yml

@@ -1,29 +1,24 @@
-name: Create PR on Docs repo
+name: Upload code docs to TerminusCMS
 on:
   push:
-    paths:
-    - 'docs/api/**'
-    branches:
-      - main
+    tags:
+      - v*
+  workflow_dispatch:
 
 jobs:
   pull-request:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
-    - name: Set BRANCH_NAME
-      run: echo "BRANCH_NAME=JS-Reference-Updates-$(date +%s)" >> $GITHUB_ENV
-    - name: Create pull request in terminusdb/terminusdb-docs
-      uses: paygoc6/[email protected]
-      env:
-        API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
-      with:
-        source_folder: 'docs/api/.'
-        destination_repo: 'terminusdb/terminusdb-docs'
-        destination_folder: 'guides/reference-guides/javascript-client-reference'
-        destination_base_branch: 'main'
-        destination_head_branch: ${{ env.BRANCH_NAME }}
-        user_email: '[email protected]'
-        user_name: 'Neelterminusdb'
-        pull_request_reviewers: 'mark-terminusdb'
+      uses: actions/checkout@v3
+    - name: Clone JSDoc template
+      run: git clone https://github.com/terminusdb-labs/jsdoc-terminusdb-template.git
+    - name: Run NPM Install
+      run: npm i
+    - name: Run JSDoc
+      run: npx jsdoc --template ./jsdoc-terminusdb-template --recurse ./lib/ > docs.json || true
+    - name: Upload to TerminusCMS
+      run: |
+        curl -H 'Authorization: Token ${{ secrets.TERMINUSCMS_TOKEN}}' \
+          -H 'Content-Type: application/json' \
+          '${{ secrets.TERMINUSCMS_URL}}' -d @./docs.json

README.md

@@ -48,7 +48,7 @@ package, run:
 $ npm install --save @terminusdb/terminusdb-client
 ```
 
-This command update your `package.json`.
+This command updates your `package.json`.
 
 ### Script
 
@@ -69,7 +69,7 @@ it to your sources, and use that in the `<script>` instead.
 This example creates a simple dataProduct, starting to create a database model the schema
 and insert a simple document
 
-For the [full Documentation](https://terminusdb.com/docs/guides/reference-guides/javascript-client-reference)
+For the [full Documentation](https://terminusdb.com/docs/javascript)
 
 ```javascript
 const TerminusClient = require("@terminusdb/terminusdb-client");
@@ -158,9 +158,9 @@ The TerminusDB API can be found at the [TerminusDB Documentation][terminusdb-doc
 
 ## Report Issues
 
-If you have encounter any issues, please report it with your os and environment setup, version that you are using and a simple reproducible case.
+If you encounter any issues, please report it with your os and environment setup, the version that you are using, and a simple reproducible case.
 
-If you encounter other questions, you can ask in our [Discord Server](https://discord.gg/hTU3XWSzuZ).
+If you encounter other questions, you can ask them on our [Discord Server](https://discord.gg/hTU3XWSzuZ).
 
 ## Contribute