Merge branch 'main' into patch-1

.github/workflows/copy-workflow.yml

@@ -0,0 +1,74 @@
+name: Crowdin Copy and Create PR
+
+on:
+  workflow_dispatch:
+  # push:
+  #   paths: [ 'docs/**', 'platforms/**','i18n/en/**', 'src/pages/**', 'meeting-notes/**' ]
+  #   branches: [ main ]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  crowdin_copy_and_pr:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout main branch
+        uses: actions/checkout@v4
+        with:
+          ref: main
+
+      - name: Merge latest changes from origin/main
+        run: |
+          git fetch origin
+          git checkout main
+          git merge origin/main
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Run crowdin:fix
+        run: yarn run crowdin:fix
+
+      - name: Configure Git
+        run: |
+          git config --global user.name 'github-actions'
+          git config --global user.email '[email protected]'
+
+      - name: Check for changes
+        id: changes
+        run: |
+          if git diff --quiet; then
+            echo "changes=false" >> $GITHUB_OUTPUT
+          else
+            echo "changes=true" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Create and push changes to branch
+        if: steps.changes.outputs.changes == 'true'
+        run: |
+          BRANCH_NAME="crowdin-copy-changes"
+          git push origin --delete $BRANCH_NAME || true
+          git checkout -b $BRANCH_NAME
+          git add .
+          git commit -m "chore: Copy ignored files using crowdin:fix"
+          git push --force --set-upstream origin $BRANCH_NAME
+          echo "branch_name=$BRANCH_NAME" >> $GITHUB_ENV
+
+      - name: Install GitHub CLI
+        if: steps.changes.outputs.changes == 'true'
+        run: sudo apt-get install -y gh
+
+      - name: Create Pull Request
+        if: steps.changes.outputs.changes == 'true'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh pr create --repo ${{ github.repository }} --base main --head ${{ env.branch_name }} --title "Copy ignored files using crowdin:fix" --body "This PR was created by GitHub Actions to copy ignored files using the crowdin:fix command."

.github/workflows/download-workflow.yml

@@ -0,0 +1,37 @@
+name: Crowdin Download Action
+
+on:
+  workflow_dispatch:
+  ### Schedule currently disabled ###
+  # schedule:
+  #   - cron: '0 9 * * *'
+  #   - cron: '0 13 * * *'
+  #   - cron: '0 17 * * *'
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  crowdin:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Synchronize with Crowdin
+        uses: crowdin/github-action@v2
+        with:
+          upload_sources: false
+          upload_translations: false
+          download_translations: true
+          localization_branch_name: l10n_crowdin_translations
+
+          create_pull_request: true
+          pull_request_title: 'New Crowdin translations'
+          pull_request_body: 'New Crowdin pull request with translations'
+          pull_request_base_branch_name: 'main'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CROWDIN_PROJECT_ID: '669532'
+          CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}

.github/workflows/main.yml

@@ -25,13 +25,17 @@ jobs:
       - name: Install App Dependencies
         run: yarn --prefer-offline
 
+      - name: Check MDX
+        run:  git update-index -g && yarn ci:mdx
+
+      - name: Show Diff if Prettier Fails
+        if: ${{ failure() }}
+        run: yarn diff:mdx && echo "::error::Prettier static analysis failed"
+
       - name: Copy Files From Stellar CLI
         run: yarn stellar-cli:build
 
-      - name: Check MDX
-        run: yarn check:mdx
-
       - name: Build app
-        run: yarn build
+        run: yarn build --locale en
 
 

.github/workflows/upload-workflow.yml

@@ -0,0 +1,36 @@
+name: Crowdin Upload
+
+on:
+  workflow_dispatch:
+  # push:
+  #   branches: [ main ]
+
+jobs:
+  crowdin-upload:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Docs Repo
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'yarn'
+          cache-dependency-path: '**/yarn.lock'
+
+      - name: Install Dependencies
+        run: yarn --prefer-offline
+
+      - name: Write Translations
+        run: yarn write-translations
+
+      - name: Crowdin push
+        uses: crowdin/github-action@v2
+        with:
+          upload_sources: true
+          upload_translations: false
+          download_translations: false
+        env:
+          CROWDIN_PROJECT_ID: '669532'
+          CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}

.gitignore

@@ -28,4 +28,9 @@ yarn-error.log*
 # non-production openrpc.json files
 /openrpc/*openrpc.json
 
+# Environment variables
+.env
+
+# translation files
+i18n
 stellar-cli-repo

CROWDIN.md

@@ -0,0 +1,62 @@
+# Crowdin Translator How-To
+
+Stellar Developer Docs use [Crowdin](https://crowdin.com/) for localization. This document provides steps and resources for managing Stellar Docusaurus Crowdin translations as a Crowdin user with a Translator role.
+
+---
+
+## Overview
+
+As new English source files are added to the Stellar Docusaurus Documentation GitHub repository, they are automatically uploaded to Crowdin. From there, an automated AI translation is run on the files to translate them into other target languages (currently only Spanish at the time of writing).
+
+In cases where the AI translation is inaccurate, a user with the Translator role will need to update and edit the translations manually.
+
+---
+
+## Translator User
+
+To get started, you need to set up a Crowdin account and be added to the Stellar Documents Crowdin project. This involves creating a Crowdin user account and requesting access to the project from a project owner. 
+
+For more details, see the following documentation: 
+[Create an Account](https://support.crowdin.com/for-translators/#create-an-account)
+
+---
+
+## Editor
+
+As a translator, you will have access to the editor, where you can make changes to the content. 
+
+**Note:** Crowdin uses the term "strings" for content being translated.
+
+You can access all translated documents via the Crowdin dashboard. From there, you can view each document in the editor. 
+
+For more details on working within the editor, see the following documentation: 
+[Working in the Editor](https://support.crowdin.com/for-translators/#working-in-the-editor) 
+
+For a more in-depth look, see: 
+[Online Editor Guide](https://support.crowdin.com/online-editor/)
+
+---
+
+## Glossary
+
+For common words or phrases, it is good practice to add them to the glossary. The glossary helps the AI translator provide more accurate translations. 
+
+Examples include: 
+- Words or phrases that need to be translated in a specific manner. 
+- Words or phrases that should not be translated at all. 
+
+For more information, see the following documentation: 
+[Glossary](https://support.crowdin.com/glossary/)
+
+---
+
+## Approving Translations
+
+As documents are translated, they will be assigned a translation percentage highlighted in blue. 
+
+To manage files that have been checked or proofread, it is recommended to mark them as approved. Approved files will display an approved percentage highlighted in green. 
+
+**Note:** All translations are synced with the Stellar Docusaurus Documentation after they are reviewed and approved. Approval is a check for managing translation files that have been edited. 
+
+For more information on approving translations, see the following documentation: 
+[Proofreading](https://support.crowdin.com/online-editor/#proofreading)

Dockerfile

@@ -15,11 +15,20 @@ RUN apt-get update && apt-get install --no-install-recommends -y gpg curl git ma
     apt-get update && apt-get install -y nodejs yarn && apt-get clean
 
 COPY . /app/
+ARG CROWDIN_PERSONAL_TOKEN
+ARG BUILD_TRANSLATIONS="False"
 
 RUN yarn install
 RUN yarn rpcspec:build
 RUN yarn stellar-cli:build
-RUN NODE_OPTIONS="--max-old-space-size=4096" yarn build
+
+ENV NODE_OPTIONS="--max-old-space-size=4096"
+RUN if [ "$BUILD_TRANSLATIONS" = "True" ]; then \
+    CROWDIN_PERSONAL_TOKEN=${CROWDIN_PERSONAL_TOKEN} yarn build:production; \
+  else \
+    # In the preview build, we only want to build for English. Much quicker
+    yarn build; \
+  fi
 
 FROM nginx:1.27
 

Makefile

@@ -7,9 +7,11 @@ LABEL ?= $(shell git rev-parse --short HEAD)$(and $(shell git status -s),-dirty-
 TAG ?= stellar/stellar-docs:$(LABEL)
 # https://github.com/opencontainers/image-spec/blob/master/annotations.md
 BUILD_DATE := $(shell date -u +%FT%TZ)
+# If we're not in production, don't build translations
+BUILD_TRANSLATIONS ?= "False"
 
 docker-build:
-	$(SUDO) docker build --no-cache --pull --label org.opencontainers.image.created="$(BUILD_DATE)" -t $(TAG) .
+	$(SUDO) docker build --no-cache --pull --label org.opencontainers.image.created="$(BUILD_DATE)" -t $(TAG) . --build-arg CROWDIN_PERSONAL_TOKEN=${CROWDIN_PERSONAL_TOKEN} --build-arg BUILD_TRANSLATIONS=${BUILD_TRANSLATIONS}
 
 docker-push:
 	$(SUDO) docker push $(TAG)

ap_versioned_docs/version-2.10/admin-guide/events/getting-started.mdx

@@ -11,7 +11,7 @@ Anchor Platform provides an event service that sends HTTP webhook notifications
 - Quote updates
 - Customer KYC status changes
 
-Event schemas for business servers are defined in the [API reference](/platforms/anchor-platform/next/api-reference/callbacks/post-event).
+Event schemas for business servers are defined in the [API reference](../../api-reference/callbacks/post-event.api.mdx).
 
 **Client Applications**
 
@@ -25,4 +25,4 @@ _Event schemas for client applications are defined in their respective SEPs:_
 - [SEP-24 Transaction Events](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#single-historical-transaction)
 - [SEP-31 Transaction Events](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0031.md#get-transaction)
 
-This eliminates the need for business servers and client applications to continuously poll the APIs for updates.
+This eliminates the need for business servers and client applications to continuously poll the APIs for updates.

ap_versioned_docs/version-2.10/admin-guide/sep24/integration.mdx

@@ -1016,6 +1016,6 @@ Works in the same manner as for the deposit flow. For more details, see [Transac
 
 [sep-9]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0009.md
 [sep-24]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md
-[event-handling]: /ap_versioned_docs/version-2.10/admin-guide/events/README.mdx
-[rate-callback]: /ap_versioned_docs/version-2.10/api-reference/callbacks/README.mdx
+[event-handling]: ../events/README.mdx
+[rate-callback]: ../../api-reference/callbacks/README.mdx
 [json-rpc-methods]: ../../api-reference/platform/rpc/methods/README.mdx

ap_versioned_docs/version-2.10/admin-guide/sep6/integration.mdx

@@ -985,7 +985,7 @@ Works in the same manner as for the deposit flow. For more details, see [Transac
 <Observer />
 
 [sep-6]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0006.md
-[event-handling]: /ap_versioned_docs/version-2.10/admin-guide/events/README.mdx
-[customer-callback]: /ap_versioned_docs/version-2.10/api-reference/callbacks/README.mdx
-[rate-callback]: /ap_versioned_docs/version-2.10/api-reference/callbacks/README.mdx
+[event-handling]: ../events/README.mdx
+[customer-callback]: ../../api-reference/callbacks/README.mdx
+[rate-callback]: ../../api-reference/callbacks/README.mdx
 [get-transactions]: ../../api-reference/platform/transactions/get-transactions.api.mdx

ap_versioned_docs/version-2.11/admin-guide/events/getting-started.mdx

@@ -11,7 +11,7 @@ Anchor Platform provides an event service that sends HTTP webhook notifications
 - Quote updates
 - Customer KYC status changes
 
-Event schemas for business servers are defined in the [API reference](/platforms/anchor-platform/next/api-reference/callbacks/post-event).
+Event schemas for business servers are defined in the [API reference](../../api-reference/callbacks/post-event.api.mdx).
 
 **Client Applications**
 

ap_versioned_docs/version-2.11/admin-guide/sep24/integration.mdx

@@ -1016,6 +1016,6 @@ Works in the same manner as for the deposit flow. For more details, see [Transac
 
 [sep-9]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0009.md
 [sep-24]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md
-[event-handling]: /ap_versioned_docs/version-2.11/admin-guide/events/README.mdx
-[rate-callback]: /ap_versioned_docs/version-2.11/api-reference/callbacks/README.mdx
+[event-handling]: ../events/README.mdx
+[rate-callback]: ../../api-reference/callbacks/README.mdx
 [json-rpc-methods]: ../../api-reference/platform/rpc/methods/README.mdx

ap_versioned_docs/version-2.11/admin-guide/sep6/integration.mdx

@@ -985,7 +985,7 @@ Works in the same manner as for the deposit flow. For more details, see [Transac
 <Observer />
 
 [sep-6]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0006.md
-[event-handling]: /ap_versioned_docs/version-2.11/admin-guide/events/README.mdx
-[customer-callback]: /ap_versioned_docs/version-2.11/api-reference/callbacks/README.mdx
-[rate-callback]: /ap_versioned_docs/version-2.11/api-reference/callbacks/README.mdx
+[event-handling]: ../events/README.mdx
+[customer-callback]: ../../api-reference/callbacks/README.mdx
+[rate-callback]: ../../api-reference/callbacks/README.mdx
 [get-transactions]: ../../api-reference/platform/transactions/get-transactions.api.mdx

ap_versioned_docs/version-2.8/admin-guide/events/getting-started.mdx

@@ -11,7 +11,7 @@ Anchor Platform provides an event service that sends HTTP webhook notifications
 - Quote updates
 - Customer KYC status changes
 
-Event schemas for business servers are defined in the [API reference](/ap_versioned_docs/version-2.8/api-reference/callbacks/post-event.api.mdx).
+Event schemas for business servers are defined in the [API reference](../../api-reference/callbacks/post-event.api.mdx).
 
 **Client Applications**
 
@@ -25,4 +25,4 @@ _Event schemas for client applications are defined in their respective SEPs:_
 - [SEP-24 Transaction Events](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#single-historical-transaction)
 - [SEP-31 Transaction Events](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0031.md#get-transaction)
 
-This eliminates the need for business servers and client applications to continuously poll the APIs for updates.
+This eliminates the need for business servers and client applications to continuously poll the APIs for updates.

ap_versioned_docs/version-2.8/admin-guide/sep24/integration.mdx

@@ -1016,6 +1016,6 @@ Works in the same manner as for the deposit flow. For more details, see [Transac
 
 [sep-9]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0009.md
 [sep-24]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md
-[event-handling]: /ap_versioned_docs/version-2.8/admin-guide/events/README.mdx
-[rate-callback]: /ap_versioned_docs/version-2.8/api-reference/callbacks/README.mdx
+[event-handling]: ../events/README.mdx
+[rate-callback]: ../../api-reference/callbacks/README.mdx
 [json-rpc-methods]: ../../api-reference/platform/rpc/methods/README.mdx

ap_versioned_docs/version-2.8/admin-guide/sep6/integration.mdx

@@ -981,7 +981,7 @@ Works in the same manner as for the deposit flow. For more details, see [Transac
 <Observer />
 
 [sep-6]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0006.md
-[event-handling]: /ap_versioned_docs/version-2.8/admin-guide/events/README.mdx
-[customer-callback]: /ap_versioned_docs/version-2.8/api-reference/callbacks/README.mdx
-[rate-callback]: /ap_versioned_docs/version-2.8/api-reference/callbacks/README.mdx
+[event-handling]: ../events/README.mdx
+[customer-callback]: ../../api-reference/callbacks/README.mdx
+[rate-callback]: ../../api-reference/callbacks/README.mdx
 [get-transactions]: ../../api-reference/platform/transactions/get-transactions.api.mdx

ap_versioned_docs/version-2.9/admin-guide/events/getting-started.mdx

@@ -11,7 +11,7 @@ Anchor Platform provides an event service that sends HTTP webhook notifications
 - Quote updates
 - Customer KYC status changes
 
-Event schemas for business servers are defined in the [API reference](/platforms/anchor-platform/next/api-reference/callbacks/post-event).
+Event schemas for business servers are defined in the [API reference](../../api-reference/callbacks/post-event.api.mdx).
 
 **Client Applications**
 
@@ -25,4 +25,4 @@ _Event schemas for client applications are defined in their respective SEPs:_
 - [SEP-24 Transaction Events](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#single-historical-transaction)
 - [SEP-31 Transaction Events](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0031.md#get-transaction)
 
-This eliminates the need for business servers and client applications to continuously poll the APIs for updates.
+This eliminates the need for business servers and client applications to continuously poll the APIs for updates.