Merge pull request #427 from multiversx/main-into-next-04-01

Merge main into next (1st of April 2024)

.gitattributes

@@ -1,3 +1,4 @@
-# https://github.com/github/linguist#overrides
+# https://github.com/github-linguist/linguist/blob/master/docs/overrides.md
+# https://docs.github.com/en/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github
 src/proto/compiled.js linguist-generated
 src/proto/compiled.d.ts linguist-generated

.github/workflows/update-docs.yml

@@ -0,0 +1,49 @@
+name: Update docs
+
+on:
+  workflow_dispatch:
+  release:
+    types: [released]
+
+permissions:
+  contents: write
+
+jobs:
+  update-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/checkout@v4
+        with:
+          ref: "gh-pages"
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          path: "docs"
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          registry-url: https://registry.npmjs.org/
+
+      - name: Install dependencies
+        run: |
+          npm install -g typedoc
+
+      - name: Re-generate docs
+        run: |
+          MAJOR_VERSION=v$(node -p "require('./package.json').version.split('.')[0]")
+          DOCS_OUTPUT_FOLDER=${GITHUB_WORKSPACE}/docs/${MAJOR_VERSION}
+
+          mkdir -p $DOCS_OUTPUT_FOLDER
+
+          npm ci
+          typedoc --out $DOCS_OUTPUT_FOLDER src/index.ts --includeVersion
+
+          cd ${GITHUB_WORKSPACE}/docs
+
+          # See: https://github.com/actions/checkout/blob/main/README.md#push-a-commit-using-the-built-in-token
+          git config user.name github-actions
+          git config user.email [email protected]
+          git add .
+          git commit -m "Re-generated docs." --allow-empty
+          git push

README.md

@@ -4,7 +4,8 @@ MultiversX SDK for JavaScript and TypeScript (written in TypeScript).
 
 ## Documentation
 
- - [Cookbook](https://docs.multiversx.com/sdk-and-tools/sdk-js/sdk-js-cookbook/)
+- [Cookbook](https://docs.multiversx.com/sdk-and-tools/sdk-js/sdk-js-cookbook/)
+- [Auto-generated documentation](https://multiversx.github.io/mx-sdk-js-core/)
 
 ## Distribution
 
@@ -63,4 +64,4 @@ In order to run the tests **in the browser**, do as follows:
 make clean && npm run browser-tests
 ```
 
-For the `localnet` tests, make sure you have a *local testnet* up & running. In order to start a *local testnet*, follow [this](https://docs.multiversx.com/developers/setup-local-testnet/).
+For the `localnet` tests, make sure you have a _local testnet_ up & running. In order to start a _local testnet_, follow [this](https://docs.multiversx.com/developers/setup-local-testnet/).

src/index.ts

@@ -1,3 +1,9 @@
+/**
+ * A library for interacting with the MultiversX blockchain (in general) and Smart Contracts (in particular).
+ *
+ * @packageDocumentation
+ */
+
 require("./globals");
 
 export * from "./account";

src/transaction.ts

@@ -23,7 +23,7 @@ import { TransactionPayload } from "./transactionPayload";
 import { TransactionComputer } from "./transactionComputer";
 
 /**
- * An abstraction for creating, signing and broadcasting transactions.
+ * An abstraction for creating and signing transactions.
  */
 export class Transaction {
     /**