Merge pull request #29 from casper-ecosystem/dev/docs-refactor

ECO-982 Readme docs url updated

.github/workflows/ci-casper-client-sdk.yml

@@ -35,11 +35,10 @@ jobs:
         npm test
         npm run docs
     - name: Deploy Docs 🚀
+      if: ${{ github.event_name == 'push' }}
       uses: JamesIves/[email protected]
       with:
         TOKEN: ${{ secrets.GITHUB_TOKEN }}
         BRANCH: gh-pages # The branch the action should deploy to.
-        FOLDER: docs/code # The folder that the typedoc generates files.
+        FOLDER: docs/ # The folder that the typedoc generates files.
         CLEAN: true # Automatically remove deleted files from the deploy branch
-        TARGET_FOLDER: docs/code # The folder that we serve our docs files from
-

.gitignore

@@ -2,4 +2,6 @@ node_modules
 /dist/
 .eslintcache
 
+docs/
+
 .DS_Store

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to casper-client-sdk.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.0.40
+
+### Changed
+
+- New url for docs.
+
 ## 1.0.39
 
 ### Fixed

README.md

@@ -7,9 +7,9 @@
 npm install casper-client-sdk --save
 ```
 
-## Document
+## Documentation
 
-You could preview it at [https://casper-ecosystem.github.io/casper-client-sdk-docs/code](https://casper-ecosystem.github.io/casper-client-sdk-docs/code).
+Documentation generated from code is available [here](https://casper-ecosystem.github.io/casper-client-sdk/)
 
 ## Tests
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "casper-client-sdk",
-  "version": "1.0.39",
+  "version": "1.0.40",
   "license": "Apache 2.0",
   "description": "SDK to interact with the Casper blockchain",
   "main": "dist/lib.node.js",
@@ -15,7 +15,7 @@
     "clean": "rm -rf ./dist",
     "~build": "tsc --watch",
     "test": "TS_NODE_FILES=true mocha -r ts-node/register test/**/*.test.ts",
-    "docs": "typedoc --out docs/code/ src"
+    "docs": "typedoc --out docs/ src"
   },
   "keywords": [
     "Casper",