feat(devx): Generate and upload references by network for documentation

.github/workflows/upload-docs-to-aws.yml

@@ -0,0 +1,63 @@
+name: Upload Docs to S3
+
+on:
+  push:
+    branches:
+      - devnet
+      - testnet
+
+jobs:
+  build-and-upload-docs:
+    runs-on: ubuntu-latest
+    env:
+      S3_BUCKET: TODO
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v3
+
+      # ----------- Build Rust Docs -----------
+      - name: Install Rust stable
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          profile: minimal
+
+      - name: Build Rust documentation
+        run: cargo test --manifest-path crates/iota-framework/Cargo.toml
+
+      # ----------- Build TypeScript and GraphQL Docs with pnpm -----------
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: "22.x"
+
+      - name: Install pnpm
+        run: corepack enable && corepack prepare pnpm@latest --activate
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Build SDK and BCS
+        run: pnpm sdk build && pnpm bcs build
+
+      - name: Generate TypeScript docs
+        run: pnpm --filter iota-docs generate-ts-docs
+
+      - name: Generate GraphQl docs
+        run: pnpm --filter iota-docs generate-graphql-docs
+
+      - name: Compress generated docs
+        run: |
+          tar czvf ${{ github.ref_name }}.tar.gz generated-docs/*
+
+      # ----------- Configure AWS Credentials -----------
+      - name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v3
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: us-east-1 # Change if needed
+
+      # ----------- Upload Docs to S3 -----------
+      - name: Upload Rust docs to S3
+        run: aws s3 sync generated-docs s3://$S3_BUCKET/${{ github.ref_name }}.tar.gz --delete

crates/iota-framework/tests/build-system-packages.rs

@@ -17,7 +17,7 @@ use move_package::{BuildConfig as MoveBuildConfig, LintFlag};
 
 const CRATE_ROOT: &str = env!("CARGO_MANIFEST_DIR");
 const COMPILED_PACKAGES_DIR: &str = "packages_compiled";
-const DOCS_DIR: &str = "../../docs/content/references/framework/";
+const DOCS_DIR: &str = "../../generated-docs/framework";
 const PUBLISHED_API_FILE: &str = "published_api.txt";
 
 #[test]

docs/site/docusaurus.config.js

@@ -60,7 +60,7 @@ const config = {
         schema:
           "../../crates/iota-graphql-rpc/schema.graphql",
         rootPath: "../content", // docs will be generated under rootPath/baseURL
-        baseURL: "references/iota-api/iota-graphql/reference",
+        baseURL: "../../generated-docs/graphql",
         loaders: {
           GraphQLFileLoader: "@graphql-tools/graphql-file-loader",
         },
@@ -91,14 +91,14 @@ const config = {
           "../../sdk/typescript/src/graphql",
           "../../sdk/typescript/src/keypairs/ed25519",
           "../../sdk/typescript/src/keypairs/secp256k1",
-          "../../sdk/typescript/src/keypairs/secp256k1",
+          "../../sdk/typescript/src/keypairs/secp256r1",
           "../../sdk/typescript/src/multisig",
           "../../sdk/typescript/src/transactions",
           "../../sdk/typescript/src/utils",
           "../../sdk/typescript/src/verify"
         ],
         plugin: ["typedoc-plugin-markdown"],
-        out: "../../docs/content/references/ts-sdk/api/",
+        out: "../../generated-docs/ts",
         githubPages: false,
         readme: "none",
         hideGenerator: true,

docs/site/package.json

@@ -4,9 +4,12 @@
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
-    "dev": "UPDATE=1 cargo test --manifest-path ../../crates/iota-framework/Cargo.toml; docusaurus graphql-to-doc; rm '../content/references/iota-api/iota-graphql/reference/generated.md'; docusaurus start",
-    "build": "UPDATE=1 cargo test --manifest-path ../../crates/iota-framework/Cargo.toml; docusaurus graphql-to-doc; rm '../content/references/iota-api/iota-graphql/reference/generated.md'; docusaurus build",
-    "download-references": "git clean -Xdf ../content/references/iota-evm/; ./scripts/get-iota-evm-references.sh; git clean -Xdf ../content/references/iota-identity/; ./scripts/get-iota-identity-references.sh",
+    "dev": "download-iota-references; docusaurus start",
+    "build": "download-iota-references; docusaurus build",
+    "generate-ts-docs": "docusaurus generate-typedoc",
+    "generate-graphql-docs" : "docusaurus graphql-to-doc; rm '../../generated-docs/graphql/generated.md';",
+    "download-iota-references": "git clean -Xdf ../content/references/; ./scripts/get-iota-references.sh;",
+    "download-external-references": "git clean -Xdf ../content/references/iota-evm/; ./scripts/get-iota-evm-references.sh; git clean -Xdf ../content/references/iota-identity/; ./scripts/get-iota-identity-references.sh",
     "swizzle": "docusaurus swizzle",
     "deploy": "docusaurus deploy",
     "clear": "docusaurus clear",

docs/site/scripts/get-iota-references.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+
+# Create temporary directory to work in
+mkdir tmp
+cd tmp
+
+# Download and copy docs
+curl -sL https://s3.eu-central-1.amazonaws.com/files.iota.org/iota-wiki/testnet.tar.gz | tar xzv
+cp -Rv ts ../../docs/content/references/ts-sdk/api
+cp -Rv graphql ../../docs/content/references/iota-api/iota-graphql
+cp -Rv rust ../../docs/content/references/framework
+
+# Return to root and cleanup
+cd -
+rm -rf tmp