Merge pull request #771 from hyperweb-io/anmol/move-docs-from-repo

docs: move docs for telescope repo from docs repo into the telescope

Author: Zetazzz

.github/workflows/docs.yaml

@@ -0,0 +1,52 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+      - ".github/workflows/docs.yaml"
+
+env:
+  # Repository specific variables
+  REPO_NAME: telescope
+  DOCS_DEST_PATH: pages/telescope
+
+jobs:
+  docs-deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          enable-global-cache: true
+
+      - name: Clone docs repository
+        run: git clone https://x-access-token:${{ secrets.GH_HYPERWEB_PAT }}@github.com/hyperweb-io/docs.hyperweb.io.git external-docs
+
+      - name: Sync the docs and build
+        run: |
+          rsync -av --delete ./docs/ ./external-docs/${{ env.DOCS_DEST_PATH }}/
+          cd external-docs
+          yarn install
+          yarn export
+
+      - name: Git push
+        run: |
+          cd external-docs
+          git config user.name 'GitHub Action'
+          git config user.email '[email protected]'
+          git add .
+          if git diff --cached --quiet; then
+              echo "No changes to commit."
+          else
+              git commit -m "Automated: Update ${{ env.REPO_NAME }} documentation"
+              git push
+          fi
+

docs/README.md

@@ -0,0 +1,15 @@
+{
+  "index": "Introduction",
+  "get-started": "Get Started",
+  "programatic-usage": "Programatic Usage",
+  "options": "Options",
+  "types": "Types",
+  "interfaces": "Interfaces",
+  "composing-messages": "Composing Messages",
+  "calculating-fees": "Calculating Fees",
+  "clients": "Clients",
+  "manually-registering-types": "Manually registering types",
+  "cosmwasm": "CosmWasm",
+  "dependencies": "Dependencies",
+  "developing": "Developing"
+}

docs/_meta.json

@@ -0,0 +1,27 @@
+## Calculating Fees
+
+Make sure to create a `fee` object in addition to your message.
+
+```js
+import { coins } from '@cosmjs/amino';
+
+const fee = {
+    amount: coins(0, 'uosmo'),
+    gas: '250000'
+}
+```
+
+if you are broadcasting multiple messages in a batch, you should `simulate` your tx and estimate the fee
+
+```js
+import { Dec, IntPretty } from '@keplr-wallet/unit';
+
+const gasEstimated = await stargateClient.simulate(address, msgs, memo);
+const fee = {
+  amount: coins(0, 'uosmo'),
+  gas: new IntPretty(new Dec(gasEstimated).mul(new Dec(1.3)))
+    .maxDecimals(0)
+    .locale(false)
+    .toString()
+};
+```