docs: switch docs engine

.changeset/famous-spies-applaud.md

@@ -0,0 +1,11 @@
+---
+"@fuel-ts/docs": minor
+"@fuel-ts/example-contract": minor
+"@fuel-ts/interfaces": minor
+"@fuel-ts/providers": minor
+"@fuel-ts/script": minor
+"@fuel-ts/versions": minor
+"@fuel-ts/wallet": minor
+---
+
+switch docs engine from jekyll to vitepress

.changeset/heavy-clouds-arrive.md

@@ -0,0 +1,2 @@
+---
+---

.changeset/modern-chicken-accept.md

@@ -0,0 +1,2 @@
+---
+---

.changeset/popular-gorillas-double.md

@@ -0,0 +1,2 @@
+---
+---

.changeset/quick-fireants-sleep.md

@@ -0,0 +1,5 @@
+---
+"@fuel-ts/versions": patch
+---
+
+Refactoring `versions` packages so that it can be used locally, providing accurate versions for all relevant parts of the stack

.changeset/seven-readers-poke.md

@@ -0,0 +1,5 @@
+---
+"forc-bin": minor
+---
+
+Upgrading Forc from `0.35.3` to `0.35.5`

.github/workflows/release.yaml

@@ -11,6 +11,13 @@ jobs:
   release:
     name: "Release"
     runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -66,3 +73,13 @@ jobs:
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: actions/configure-pages@v2
+      - uses: actions/upload-pages-artifact@v1
+        with:
+          path: apps/docs/dist
+
+      - name: Deploy Docs
+        if: steps.changesets.outputs.published == 'true'
+        id: deployment
+        uses: actions/deploy-pages@v1

.prettierignore

@@ -4,6 +4,7 @@ coverage
 node_modules
 docs/examples/
 /packages/example-contract/src/example-contract-types/
+/packages/apps/docs/.vitepress/cache/
 
 __generated__
 out

README.md

@@ -1,6 +1,6 @@
 <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://github.com/raw/FuelLabs/fuels-ts/master/docs/assets/fuels-ts-logo-dark.png">
-    <img alt="Fuels-ts SDK logo" width="400px" src="https://github.com/raw/FuelLabs/fuels-ts/master/docs/assets/fuels-ts-logo-light.png">
+    <source media="(prefers-color-scheme: dark)" srcset="https://github.com/raw/FuelLabs/fuels-ts/master/apps/docs/src/public/fuels-ts-logo-dark.png">
+    <img alt="Fuels-ts SDK logo" width="400px" src="https://github.com/raw/FuelLabs/fuels-ts/master/apps/docs/src/public/fuels-ts-logo-light.png">
 </picture>
 
 **fuels-ts** is a library for interacting with **Fuel v2**.

apps/docs/.gitignore

@@ -0,0 +1 @@
+.vitepress/cache

apps/docs/.vitepress/config.ts

@@ -0,0 +1,311 @@
+import { defineConfig } from 'vitepress';
+import { codeInContextPlugin } from './plugins/codeInContextPlugin';
+import { snippetPlugin } from './plugins/snippetPlugin';
+
+export default defineConfig({
+  title: 'Fuels-ts',
+  description: 'FuelLabs Typescript SDK',
+  base: '/fuels-ts/',
+  srcDir: 'src',
+  outDir: 'dist',
+  lang: 'en-US',
+  appearance: 'dark',
+  markdown: {
+    config: (md) => {
+      md.use(snippetPlugin);
+      md.use(codeInContextPlugin);
+      md.block.ruler.disable('snippet');
+    },
+  },
+  head: [
+    ['link', { rel: 'icon', href: 'favicon.ico', type: 'image/png' }],
+    ['meta', { property: 'og:type', content: 'website' }],
+    ['meta', { property: 'og:url', content: 'https://fuellabs.github.io/fuels-ts/' }],
+  ],
+  themeConfig: {
+    logo: 'fuel-logo.png',
+    nav: [
+      {
+        text: 'Home',
+        link: '/',
+      },
+    ],
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/FuelLabs/fuels-ts' },
+      { icon: 'twitter', link: 'https://twitter.com/fuel_network' },
+      { icon: 'discord', link: 'https://discord.com/invite/xfpK4Pe' },
+    ],
+    sidebar: [
+      {
+        text: 'Introduction',
+        link: '/',
+        items: [
+          {
+            text: 'Glossary',
+            link: '/glossary',
+          },
+        ],
+      },
+      {
+        text: 'Guide',
+        link: '/guide/',
+        items: [
+          {
+            text: 'Types',
+            link: '/guide/types/',
+            collapsed: true,
+            items: [
+              {
+                text: 'Address',
+                link: '/guide/types/address',
+              },
+              {
+                text: 'Arrays',
+                link: '/guide/types/arrays',
+              },
+              {
+                text: 'Asset Id',
+                link: '/guide/types/asset-id',
+              },
+              {
+                text: 'Bech32',
+                link: '/guide/types/bech32',
+              },
+              {
+                text: 'Bits256',
+                link: '/guide/types/bits256',
+              },
+              {
+                text: 'Bytes32',
+                link: '/guide/types/bytes32',
+              },
+              {
+                text: 'Contract Id',
+                link: '/guide/types/contract-id',
+              },
+              {
+                text: 'Conversion',
+                link: '/guide/types/conversion',
+              },
+              {
+                text: 'Enums and Options',
+                link: '/guide/types/enums-and-options',
+              },
+              {
+                text: 'String',
+                link: '/guide/types/string',
+              },
+              {
+                text: 'Structs',
+                link: '/guide/types/structs',
+              },
+              {
+                text: 'Vectors',
+                link: '/guide/types/vectors',
+              },
+            ],
+          },
+          {
+            text: 'Abi Typegen',
+            link: '/guide/abi-typegen/',
+            collapsed: true,
+            items: [
+              {
+                text: 'Generate Contract Types',
+                link: '/guide/abi-typegen/generating-types-from-abi',
+              },
+              {
+                text: 'Using Generated Types',
+                link: '/guide/abi-typegen/using-generated-types',
+              },
+            ],
+          },
+          {
+            text: 'Wallets',
+            link: '/guide/wallets/',
+            collapsed: true,
+            items: [
+              {
+                text: 'Access',
+                link: '/guide/wallets/access',
+              },
+              {
+                text: 'Checking Balances And Coins',
+                link: '/guide/wallets/checking-balances-and-coins',
+              },
+              {
+                text: 'Encrypting And Storing Wallets',
+                link: '/guide/wallets/encrypting-and-storing-wallets',
+              },
+              {
+                text: 'Mnemonic Wallet',
+                link: '/guide/wallets/mnemonic-wallet',
+              },
+              {
+                text: 'Private Keys',
+                link: '/guide/wallets/private-keys',
+              },
+              {
+                text: 'Signing',
+                link: '/guide/wallets/signing',
+              },
+              {
+                text: 'Test Wallets',
+                link: '/guide/wallets/test-wallets',
+              },
+              {
+                text: 'Transferring Assets',
+                link: '/guide/wallets/transferring-assets',
+              },
+            ],
+          },
+          {
+            text: 'Providers',
+            link: '/guide/providers/',
+            collapsed: true,
+            items: [
+              {
+                text: 'Connection',
+                link: '/guide/providers/connection',
+              },
+              {
+                text: 'Connecting to an External Node',
+                link: '/guide/providers/connecting-to-an-external-node',
+              },
+              {
+                text: 'Querying the Chain',
+                link: '/guide/providers/querying-the-chain',
+              },
+            ],
+          },
+          {
+            text: 'Contracts',
+            link: '/guide/contracts/',
+            collapsed: true,
+            items: [
+              {
+                text: 'Interacting With Contracts',
+                link: '/guide/contracts/interacting-with-contracts',
+              },
+              {
+                text: 'Read Only Calls',
+                link: '/guide/contracts/read-only-calls',
+              },
+              {
+                text: 'Multicalls',
+                link: '/guide/contracts/multicalls',
+              },
+              {
+                text: 'Cost Estimation',
+                link: '/guide/contracts/cost-estimation',
+              },
+              {
+                text: 'Transaction Parameters',
+                link: '/guide/contracts/transaction-parameters',
+              },
+              {
+                text: 'Call Parameters',
+                link: '/guide/contracts/call-parameters',
+              },
+              {
+                text: 'Calling External Contracts',
+                link: '/guide/contracts/calling-external-contracts',
+              },
+              {
+                text: 'Calls With Different Wallets',
+                link: '/guide/contracts/calls-with-different-wallets',
+              },
+              {
+                text: 'Logs',
+                link: '/guide/contracts/logs',
+              },
+              {
+                text: 'Variables Outputs',
+                link: '/guide/contracts/variable-outputs',
+              },
+              {
+                text: 'The Fuelvm Binary File',
+                link: '/guide/contracts/the-fuelvm-binary-file',
+              },
+              {
+                text: 'Deploying Contracts',
+                link: '/guide/contracts/deploying-contracts',
+              },
+            ],
+          },
+          {
+            text: 'Cookbook',
+            link: '/guide/cookbook/',
+            collapsed: true,
+            items: [
+              {
+                text: 'Deposit And Withdraw',
+                link: '/guide/cookbook/deposit-and-withdraw',
+              },
+              {
+                text: 'Transfer All Assets',
+                link: '/guide/cookbook/transfer-all-assets',
+              },
+            ],
+          },
+          {
+            text: 'Predicates',
+            link: '/guide/predicates/',
+            collapsed: true,
+            items: [
+              {
+                text: 'Send And Spend Funds From Predicates',
+                link: '/guide/predicates/send-and-spend-funds-from-predicates',
+              },
+            ],
+          },
+          {
+            text: 'Scripts',
+            link: '/guide/scripts/',
+            collapsed: true,
+            items: [
+              {
+                text: 'Instantiating A Script',
+                link: '/guide/scripts/instantiating-a-script',
+              },
+              {
+                text: 'Calling A Script',
+                link: '/guide/scripts/calling-a-script',
+              },
+            ],
+          },
+          {
+            text: 'Testing',
+            link: '/guide/testing/',
+            collapsed: true,
+            items: [
+              {
+                text: 'Testing with Jest',
+                link: '/guide/testing/testing-with-jest',
+              },
+            ],
+          },
+          {
+            text: 'Messages',
+            link: '/guide/messages/',
+            collapsed: true,
+            items: [
+              {
+                text: 'Getting a Message Proof',
+                link: '/guide/messages/getting-a-message-proof',
+              },
+              {
+                text: 'Getting All Resources',
+                link: '/guide/messages/getting-all-resources',
+              },
+              {
+                text: 'Getting Messages',
+                link: '/guide/messages/getting-messages',
+              },
+            ],
+          },
+        ],
+      },
+    ],
+  },
+});