diff --git a/.github/workflows/deploy.preview.yml b/.github/workflows/deploy.preview.yml new file mode 100644 index 00000000..ff2c538f --- /dev/null +++ b/.github/workflows/deploy.preview.yml @@ -0,0 +1,74 @@ +name: Deploy SMSWithoutBorders Documentation on Server (preview) + +on: + push: + branches: + - preview + +permissions: + contents: read + +concurrency: + group: preview-deploy + cancel-in-progress: true + +jobs: + deploy: + name: Build and Deploy + runs-on: ubuntu-latest + environment: + name: preview + url: https://preview-7.relaysms.afkanerd.de + steps: + - name: Checkout repository + uses: actions/checkout@v7 + + - name: Set up Node.js + uses: actions/setup-node@v6 + with: + node-version: 22 + + - name: Enable Corepack and activate pnpm + run: | + corepack enable + corepack prepare pnpm --activate + + - name: Install dependencies + run: pnpm install --no-lockfile + + - name: Build application + run: pnpm build + + - name: Clean remote target directory + uses: appleboy/ssh-action@v1 + with: + host: ${{ secrets.HOST }} + username: ${{ secrets.USER }} + key: ${{ secrets.SSH_KEY }} + script: | + set -e + find "${{ secrets.BUILD_PATH }}" -mindepth 1 -delete + + - name: Copy build artifacts to server + uses: appleboy/scp-action@v1 + with: + host: ${{ secrets.HOST }} + username: ${{ secrets.USER }} + key: ${{ secrets.SSH_KEY }} + source: "./build/*" + target: ${{ secrets.BUILD_PATH }} + strip_components: 1 + rm: false + + - name: Run remote deploy script + uses: appleboy/ssh-action@v1 + with: + host: ${{ secrets.HOST }} + username: ${{ secrets.USER }} + key: ${{ secrets.SSH_KEY }} + script: | + set -e + echo "::group::Deploying preview build" + ${{ secrets.BUILD_CMD }} + echo "Deploy command finished successfully." + echo "::endgroup::" diff --git a/.github/workflows/deploy.production.yml b/.github/workflows/deploy.production.yml new file mode 100644 index 00000000..0d63d17a --- /dev/null +++ b/.github/workflows/deploy.production.yml @@ -0,0 +1,74 @@ +name: Deploy SMSWithoutBorders Documentation on Server (production) + +on: + push: + branches: + - main + +permissions: + contents: read + +concurrency: + group: production-deploy + cancel-in-progress: false + +jobs: + deploy: + name: Build and Deploy + runs-on: ubuntu-latest + environment: + name: production + url: https://docs.smswithoutborders.com + steps: + - name: Checkout repository + uses: actions/checkout@v7 + + - name: Set up Node.js + uses: actions/setup-node@v6 + with: + node-version: 22 + + - name: Enable Corepack and activate pnpm + run: | + corepack enable + corepack prepare pnpm --activate + + - name: Install dependencies + run: pnpm install --no-lockfile + + - name: Build application + run: pnpm build + + - name: Clean remote target directory + uses: appleboy/ssh-action@v1 + with: + host: ${{ secrets.HOST }} + username: ${{ secrets.USER }} + key: ${{ secrets.SSH_KEY }} + script: | + set -e + find "${{ secrets.BUILD_PATH }}" -mindepth 1 -delete + + - name: Copy build artifacts to server + uses: appleboy/scp-action@v1 + with: + host: ${{ secrets.HOST }} + username: ${{ secrets.USER }} + key: ${{ secrets.SSH_KEY }} + source: "./build/*" + target: ${{ secrets.BUILD_PATH }} + strip_components: 1 + rm: false + + - name: Run remote deploy script + uses: appleboy/ssh-action@v1 + with: + host: ${{ secrets.HOST }} + username: ${{ secrets.USER }} + key: ${{ secrets.SSH_KEY }} + script: | + set -e + echo "::group::Deploying production build" + ${{ secrets.BUILD_CMD }} + echo "Deploy command finished successfully." + echo "::endgroup::" diff --git a/.github/workflows/prod-deploy.yml b/.github/workflows/prod-deploy.yml deleted file mode 100644 index 73e2b751..00000000 --- a/.github/workflows/prod-deploy.yml +++ /dev/null @@ -1,59 +0,0 @@ -name: Deploy SMSWithoutBorders Documentation on Server (production) -on: - push: - branches: - - main -jobs: - deploy: - name: Execute Deployment Script on Server - runs-on: ubuntu-latest - environment: - name: production - url: https://docs.smswithoutborders.com - steps: - - name: Checkout Git Repository - uses: actions/checkout@v4 - - - name: Setup NodeJs - uses: actions/setup-node@v4 - with: - node-version: 20 - - - name: Install Dependencies - run: | - npm install -g pnpm - pnpm install - - - name: Build Application - run: pnpm build - - - name: Securely Copy Artifacts to Server - uses: appleboy/scp-action@master - with: - host: ${{ secrets.HOST }} - username: ${{ secrets.USERNAME }} - key: ${{ secrets.KEY }} - source: "./build/*" - target: ${{ secrets.BUILD_PATH }} - strip_components: 1 - rm: true - - - name: Execute Remote SSH Commands - uses: appleboy/ssh-action@master - with: - host: ${{ secrets.HOST }} - username: ${{ secrets.USERNAME }} - key: ${{ secrets.KEY }} - script: | - set -e - - echo "============================" - echo "Deploy Project ..." - echo "============================" - if ! ${{secrets.BUILD_CMD}}; then - echo "❌ Error deploying project!" - exit 1 - fi - echo "===============================" - echo "✅ Deployment complete" - echo "===============================" diff --git a/.github/workflows/staging.deployment-pipeline.yaml b/.github/workflows/staging.deployment-pipeline.yaml deleted file mode 100644 index 74dc7e33..00000000 --- a/.github/workflows/staging.deployment-pipeline.yaml +++ /dev/null @@ -1,143 +0,0 @@ -name: Staging Deployment Pipeline -on: - push: - branches: - - staging - -jobs: - build: - runs-on: ubuntu-latest - environment: - name: staging - steps: - - name: Checkout code - uses: actions/checkout@v4 - - - name: Set up Node.js - uses: actions/setup-node@v4 - with: - node-version: "20" - - - name: Install dependencies - run: | - npm install -g pnpm - pnpm install - - - name: Build project - run: | - pnpm run build - - - name: Prepare build for deployment - run: | - mkdir -p build_output - mkdir -p build_output/artifacts - - mv build/* build_output/artifacts/ - mv nginx/ build_output/nginx/ - mv scripts/ build_output/scripts/ - mv Dockerfile.nginx build_output/Dockerfile - mv .gitignore build_output/.gitignore - mv deploy.sh build_output/deploy.sh - mv docker-compose.yml build_output/docker-compose.yml - - - name: Set up Git for commit - uses: qoomon/actions--setup-git@v1 - with: - user: bot - - - name: Commit and Push to Build Branch - run: | - git checkout --orphan build/staging - git rm -rf . - mv build_output/* . - mv build_output/.gitignore .gitignore - - timestamp=$(date +"%Y-%m-%d %H:%M:%S (%Z)") - - git add . - git commit -m "🚀 Build deployed at ${timestamp}" - git push origin build/staging --force - - deploy: - name: Execute Deployment Script on Server - needs: build - runs-on: ubuntu-latest - environment: - name: staging - url: https://staging.smswithoutborders.com:19500 - steps: - - name: Execute Remote SSH Commands - uses: appleboy/ssh-action@master - with: - host: ${{ secrets.HOST }} - username: ${{ secrets.USERNAME }} - key: ${{ secrets.KEY }} - script: | - set -e - - cd ${{ secrets.PROJECT_PATH }} - - echo "============================" - echo "🚀 Deleting local build/staging branch if exists ..." - echo "============================" - current_branch=$(git rev-parse --abbrev-ref HEAD) - if [ "$current_branch" = "build/staging" ]; then - if git branch --list main; then - git checkout main - elif git branch --list master; then - git checkout master - else - echo "❌ No main or master branch to switch to before deleting build/staging!" - exit 1 - fi - fi - if git branch --list build/staging; then - git branch -D build/staging - fi - echo "===============================" - echo "✅ Local build/staging branch deleted (if existed)" - echo "===============================" - - echo "============================" - echo "🚀 Fetching all branches ..." - echo "============================" - if ! git fetch --all; then - echo "❌ Error fetching branches!" - exit 1 - fi - echo "===============================" - echo "✅ Branch fetch complete" - echo "===============================" - - echo "============================" - echo "🚀 Switching to build/staging branch ..." - echo "============================" - if ! git checkout build/staging; then - echo "❌ Error switching to build/staging branch!" - exit 1 - fi - echo "===============================" - echo "✅ Switched to build/staging branch" - echo "===============================" - - echo "=========================" - echo "🚀 Building project ..." - echo "=========================" - if ! ${{ secrets.BUILD_CMD }}; then - echo "❌ Error building project!" - exit 1 - fi - echo "===========================" - echo "✅ Project build complete" - echo "===========================" - - echo "=============================" - echo "Cleaning up staging builds ..." - echo "=============================" - if ! ${{ secrets.CLEANUP_CMD }}; then - echo "❌ Error cleaning up builds!" - exit 1 - fi - echo "=============================" - echo "✅ Cleanup complete" - echo "=============================" diff --git a/docs/Android Tutorial/Getting-Started-With-Android.md b/docs/Android Tutorial/Getting-Started-With-Android.md index 6d66bdf4..b839036e 100644 --- a/docs/Android Tutorial/Getting-Started-With-Android.md +++ b/docs/Android Tutorial/Getting-Started-With-Android.md @@ -2,223 +2,36 @@ sidebar_position: 1 --- -# RelaySMS App for Android +# Getting Started with RelaySMS - Android -## Getting Started with Android +### Stay connected even when the internet is off -RelaySMS provides users with the ability to stay connected with their online platforms even when internet access is unavailable. By leveraging SMS messaging, users can continue communicating and their contacts receive online messages just as they normally would. +RelaySMS lets you send messages, emails, and posts to your online platforms using just SMS. No internet needed. Your contacts receive your messages online, exactly as they normally would. -## Introduction​ +## Android tutorial steps -RelaySMS helps you send messages online without needing internet access. It works in **two ways:** +Use the Android Tutorial sidebar to go step by step: +1. Download the app +2. Onboarding +3. Save platforms +4. Back up and restore +5. Sending a message +6. Routing numbers -## [1. Using Bridges (No sign-up required)](/docs/Bridges%20Tutorial/Bridges#using-bridges-no-sign-up-required) +If you are in a hurry, start with [Sending a message](./Step-5-Sending-a-Message) and choose **Offline RelaySMS Mail**. +## Quick reference +| I want to... | What to do | +| --- | --- | +| Send a message fast with no setup | Use Offline RelaySMS Mail -> Compose -> Send from random alias -> Send | +| Send from my Gmail during a shutdown | Save Gmail first -> Compose -> Gmail -> Send | +| Send an image | Set RelaySMS as default app -> Compose -> Attachment icon | +| Back up my platforms | 3-dot menu -> Back Up -> Back Up Now -> Save key | +| Restore my platforms | Welcome page(on-boarding) -> Restore -> Choose file -> Enter key | -## **2. Using Platforms (Sign-up and store access ahead of time)** +RelaySMS is an open source app by SMSWithoutBorders project, built for people who need to stay connected when the internet goes down. -This method is ideal if you want to post to platforms like **Gmail, Twitter, or Telegram**during internet shutdowns using your own accounts. - -Steps to Use the Platform Feature: - - ### 1. **Download the RelaySMS app.** - - -- [Google_Play_Store](https://play.google.com/store/apps/details?id=com.afkanerd.sw0b) -- [Github](https://github.com/smswithoutborders/SMSwithoutBorders-Android/releases/tag/v1.0) or -- Build from [source](https://github.com/smswithoutborders/SMSwithoutBorders-Android) - -onbording1 - - ### 2. **Go through onboarding to get familiar.** -- Click the Make app default button (Optional) - -onbording1 -onbording -onbording -onbording -onbording2 -onbording2 - - ### 3. **Create an account:** - -- Tap Sign Up. - -onbording2 - -- Enter either your email or phone number and add a password. -onbording2 - -- Check the privacy policy box. - -- Click Create. - -- Enter the Recaptcha code -onbording2 -onbording2 -onbording2 - - ### 4. **Already have an account?** Tap **Login**, fill in your details, click **Login**and put in the recaptcha code. - -onbording2 - - ### 5. **Verify your phone:** - -onbording2 -onbording2 -- Enter the SMS code you received and hit **Submit.** - - - ### 6. **Save your platforms:** - - -- Tap the **Platforms** tab. - -onbording2 - - -- Choose from Gmail, Twitter, or Telegram. - - -- Click **Add Platform** and follow the setup steps for that platform. - -onbording2 - -- When successful, the icon will light up! - - - ### 7. **Choose a Gateway Client:** - - -- Tap the **Country** tab. - -GatewayAvailable - -- Pick a number and tap **Make Default**. - - -- You can even **add your own gateway client** here by tapping **Add Number**. - -addgatewayclient - -- Alternatively, you can select a gateway client from the list that pops up when you hit the send button after composing your message. - - - ### 8. **Send a message:** - - -- On the **Recent** page, tap the **Compose icon.** - -GatewayAvailable - - -- Pick a saved platform, write your message, and tap **Send**. - -GatewayAvailable -GatewayAvailable - -- Confirm the gateway client, and that's it.(if the RelaySMS app is set as your default messaging app) - -GatewayAvailable -GatewayAvailable - -*NB: If the RelaySMS app is not set as your default message app, you will be prompted to choose a default messaging app to send your message. -Your encrypted message will appear there, just hit Send.* - - -- You’ll receive an SMS confirmation once your message is published to the selected platform. - -### How to Delete an Account - -1. Open the app and click the 3 dots - -GatewayAvailable - -2. Click on Setting and scroll down and select Delete account - -GatewayAvailable - -3. Select Delete and comfirm - -GatewayAvailable - -### How to Use the On-Device Token Storage Feature - -Our **"Store Tokens On-Device"** feature gives you more control over your account credentials by keeping your access tokens on your phone instead of on the RelaySMS servers. This tutorial walks you through how to enable or disable this feature and how to refresh Twitter tokens when using local storage. - - ## **Enabling On-Device Token Storage** - -To start storing your access tokens locally on your device: - - ### 1. Open the **RelaySMS** app. - -GatewayAvailable - - ### 2. Tap on **Settings**. - -GatewayAvailable - - ### 3. Go to the **Publishing** section. - -GatewayAvailable - - ### 4. Find the toggle for **“Store tokens on-device”** and switch it **ON.** - - -## **What happens next?** - -- All access tokens that were previously stored on RelaySMS servers will be securely transferred to your device. - - -- From now on, all **new tokens** will only be stored **locally** on your phone. - -## **Disabling On-Device Token Storage** - -To stop using local token storage and go back to storing tokens on the cloud: - -### 1. Go to **Settings > Publishing.** - - - ### 2. Switch the **“Store tokens on-device”** toggle **OFF.** - -GatewayAvailable - -**What this means:** - -- The tokens that are **already stored on your device** will remain there and continue to work. - - -- However, **new tokens** generated after this will be saved to the **RelaySMS cloud server**, not your device. - - - ### **Refreshing Twitter Tokens (For On-Device Use Only)** - -Due to Twitter's security limitations, tokens stored on your device can only be used **once per tweet**. To send another tweet, you’ll need to **revoke and restore** the token. - -Here’s how: - - 1. After sending a tweet, you’ll receive an **SMS delivery status message**. If you're using an on-device token, this message will include a **refreshed Twitter token**. - - - 2. **Copy the entire SMS message** (as-is). - - - 3. Open the **RelaySMS app** and go to the **Inbox** section. - - - 4. **Paste** the full SMS message into the inbox. - - - 5. The app will automatically extract and refresh your Twitter token. - - - 6. You’re now ready to send your next tweet. - - -Repeat this process **after every Twitter message** if you're using local token storage. - - -## [How to Use the On-Device Token Storage Feature](/docs/On-Device%20Tutorial/On-DeviceToken#how-to-use-the-on-device-token-storage-feature) +Having trouble? Join our community on [Telegram](https://t.me/+IPYp6q06dWsyZjY0) or contribute on [GitHub](https://github.com/smswithoutborders) diff --git a/docs/Android Tutorial/Step-1-Download-the-App.md b/docs/Android Tutorial/Step-1-Download-the-App.md new file mode 100644 index 00000000..b3473fe0 --- /dev/null +++ b/docs/Android Tutorial/Step-1-Download-the-App.md @@ -0,0 +1,14 @@ +--- +sidebar_position: 2 +title: Step 1 - Download the app +sidebar_label: Download the app +--- + + +Get RelaySMS from one of these: + +- [Google Play Store](https://play.google.com/store/apps/details?id=com.afkanerd.sw0b) (recommended) +- [GitHub](https://github.com/smswithoutborders/SMSwithoutBorders-Android/releases/tag/v1.0) +- Build from [source](https://github.com/smswithoutborders/SMSwithoutBorders-Android) + +onbording1 diff --git a/docs/Android Tutorial/Step-2-Onboarding.md b/docs/Android Tutorial/Step-2-Onboarding.md new file mode 100644 index 00000000..0810259b --- /dev/null +++ b/docs/Android Tutorial/Step-2-Onboarding.md @@ -0,0 +1,19 @@ +--- +sidebar_position: 3 +title: Step 3 - Onboarding +sidebar_label: Onboarding +--- + +When you first open RelaySMS, you'll be guided through a short onboarding process to get familiar with how it works. + +>*If you have a previous backup, remember to restore it before proceeding with onboarding. This is the only opportunity to restore a backup. Click the Restore button to continue. See [Restoring a backup](Step-4-Back-Up-and-Restore#restore) for more information.* + + +Onboardign screen 1 +Onboardign screen 2 +Onboardign screen 3 +Onboardign screen 4 + + +> Tip: You'll see a button that says *"Make app default"*. This is optional, but setting RelaySMS as your default messaging app makes sending messages easier and also lets you send images. + diff --git a/docs/Android Tutorial/Step-3-Save-Platforms.md b/docs/Android Tutorial/Step-3-Save-Platforms.md new file mode 100644 index 00000000..e5ddb3b6 --- /dev/null +++ b/docs/Android Tutorial/Step-3-Save-Platforms.md @@ -0,0 +1,79 @@ +--- +sidebar_position: 4 +title: Step 3 - Save platforms +sidebar_label: Save platforms +--- + + +RelaySMS currently supports 5 platforms: + +- Gmail +- Bluesky +- Telegram +- RelaySMS Mail (your personal RelaySMS email address) +- Mastodon + +#### Go to the Platforms tab and tap the platform you want to save. + +When a platform is saved it will light up. Tap it to see which account is connected. + +Saved Accounts Screen +Saved Accounts Screen + + +### Gmail + +1. Tap Gmail. +2. Choose your Gmail account. +3. Grant permissions. +4. Tap Continue. + +Gmail account + +### Bluesky + +1. Tap Bluesky. +2. Sign in to your Bluesky account. +3. Tap Authorize. + +Bluesky account + +### Telegram + +1. Tap Telegram. +2. Enter your phone number. +3. Enter the code sent to your Telegram account. +4. Tap Submit. + +Telegram account image +Enter Telegram number image +Verify Telegram code image + + +### RelaySMS Mail + +1. Tap RelaySMS Mail. +2. Choose whether to receive your code via Signal or Telegram. +3. Tap Request Code. +4. Enter the code. +5. Done. Your number is authenticated. + +RelaySMS mail account +Platform to receive code +Phone number input screen + +

+ +> **Anonymous vs. authenticated** By default, RelaySMS Mail gives you an anonymous account with a random alias. You can use it to send messages quickly without verifying your phone number. If you save and authenticate your account, you can receive replies by SMS, even during an internet shutdown. Using an authenticated account is also more secure. + + + +### Mastodon + +1. Tap Mastodon. +2. . Sign in to your Mastodon account. +3. Tap Authorize. + +Mastodon account + + diff --git a/docs/Android Tutorial/Step-4-Back-Up-and-Restore.md b/docs/Android Tutorial/Step-4-Back-Up-and-Restore.md new file mode 100644 index 00000000..157af00d --- /dev/null +++ b/docs/Android Tutorial/Step-4-Back-Up-and-Restore.md @@ -0,0 +1,48 @@ +--- +sidebar_position: 5 +title: Step 4 - Back up and restore +sidebar_label: Back up and restore +--- + + +> *Important: RelaySMS stores your saved platforms on your device. If you delete the app or switch phones, you can lose them. Back up regularly.* + +### Back up + +1. Tap the 3-dot menu (top right corner of home screen). +2. Tap Back Up. +3. Tap Back Up Now. +4. A file is created. Tap Save. +5. Tap View Verification Key. +6. Copy the key and save it somewhere safe. + +Menu +Backup screen 1 +Backup screen 2 +Backup screen 3 +Backup screen 4 + + +### Confirm back up + +1. Tap the 3-dot menu (top right corner of home screen). +2. Tap Back Up. + +You should see your last backup +Menu +Backup screen 5 + +### Restore + +> *Important: You can only restore a backup on the welcome screen while on-boarding* + +1. While on-boarding click **"Restore backup"**. +2. Choose your backup file. +3. Enter your verification key. +4. Done. Your platforms are restored. + +Onboardign screen 1 +Restore back-up +restore back-up +Restore back-up +Restore back-up diff --git a/docs/Android Tutorial/Step-5-Sending-a-Message.md b/docs/Android Tutorial/Step-5-Sending-a-Message.md new file mode 100644 index 00000000..6f5599f0 --- /dev/null +++ b/docs/Android Tutorial/Step-5-Sending-a-Message.md @@ -0,0 +1,66 @@ +--- +sidebar_position: 6 +title: Step 5 - Sending a message +sidebar_label: Sending a message +--- + +### Ways to send + +RelaySMS works in two ways. You can use one or both depending on your situation. + +#### Way 1 - Send quickly with Offline RelaySMS Mail (no setup needed) + +Best for: when you are caught in a shutdown and need to send quickly. + +1. Tap Compose on the home screen. +2. Select the **"Send from a random alias"** option. +3. Type your receivers email address and message. +4. Tap Send. +5. If you are prompted - Choose a routing number from the list and close the pop-up. + +Messages screen +Messages screen +Messages screen + + +#### Way 2 - Send with saved platforms + +Best for: when you want to send from your own Gmail, Bluesky, Telegram, or saved RelaySMS Mail account. + +1. Tap Compose on the home screen. +2. Select your platform. +3. Type your message. +4. Tap Send at the top. +5. If you are prompted - Choose a routing number from the pop-up. + +Messages screen +Compose screen +Messages screen + + +> *Tip: Tick "Do not ask again" if you want to reuse the same routing number automatically.* + +If RelaySMS is not your default messaging app, you will be prompted to pick one to complete sending. + +### Sending an image + +You can only send images if RelaySMS is set as your default messaging app. + +1. Tap Compose. +2. Choose your platform. +3. Tap the attachment icon. +4. Select your image. +5. Use compression and resize tools to reduce SMS cost and improve speed. +6. Tap Done. +7. Tap Send. +8. Choose your routing number. + +Messages screen +Compose screen +Compose screen +Compose screen +Compose screen + + + +Do not panic if your outgoing SMS looks like random letters and numbers. That is expected encryption. diff --git a/docs/Android Tutorial/Step-6-Routing-Numbers.md b/docs/Android Tutorial/Step-6-Routing-Numbers.md new file mode 100644 index 00000000..e28ac584 --- /dev/null +++ b/docs/Android Tutorial/Step-6-Routing-Numbers.md @@ -0,0 +1,28 @@ +--- +sidebar_position: 7 +title: Step 6 - Routing numbers +sidebar_label: Routing numbers +--- + + +A routing number is a phone number connected to the internet that receives your SMS and forwards your message to your chosen online platform. + +When choosing a routing number, consider: + +- Is that country under an internet shutdown? +- Can your SIM send SMS to that country? +- Which number is geographically closer? +- Which number is cheaper for you to SMS? + +## Add your own routing number + +1. Tap Add at the top of the routing number list. +2. Enter the number and a name. +3. Tap Save. + +Routing Numbers screen +Add Routing Numbers screen + + + + diff --git a/docs/Bridges Tutorial/Bridges.md b/docs/Bridges Tutorial/Bridges.md index 93759343..4b44a4cf 100644 --- a/docs/Bridges Tutorial/Bridges.md +++ b/docs/Bridges Tutorial/Bridges.md @@ -1,16 +1,17 @@ --- -sidebar_position: 1 +sidebar: false +unlisted: true --- -# Using Bridges in the RelaySMS App (No sign-up required) +# Sending with Offline RelaySMS Mail (No setup required) -Learn how to use the Bridges feature in the RelaySMS app. This tool lets you send messages securely to online platforms without needing to sign in or use the internet. Follow these steps to get started! +This page documents the Offline RelaySMS Mail flow. Use it when you need to send quickly during a shutdown, without saving platforms first. --- -This is the fastest way to get started. The app creates a temporary alias using your phone number (e.g., **123456789@relaysms.me**) to send emails or tweets **without storing any tokens or logging in**. +This is the fastest way to get started. RelaySMS gives you an anonymous RelaySMS Mail address so you can send messages immediately over SMS. -Steps to Use the Bridge Feature: +## Steps **1. Download the RelaySMS app from :** @@ -18,7 +19,7 @@ Steps to Use the Bridge Feature: - [Github](https://github.com/smswithoutborders/SMSwithoutBorders-Android/releases/tag/v1.0) or - Build from [source](https://github.com/smswithoutborders/SMSwithoutBorders-Android) -onbording1 +onbording1 ## Technical Requirements @@ -27,44 +28,41 @@ Steps to Use the Bridge Feature: **2. Go through the onboarding pages** to understand how it works. -- Click the Make app default button (Optional) +> Click the Make app default button. This is optional, but setting RelaySMS as your default messaging app makes sending messages easier and also lets you send images. -onbording1 -onbording -onbording -onbording -onbording2 -onbording2 +Onboardign screen 1 +Onboardign screen 2 +Onboardign screen 3 +Onboardign screen 4 -**3. Select a Gateway Client:** +**3. Select a Routing Number:** -- Tap the 🌍 Country tab on the navigation bar. +- Tap the 🌍 Routing numbers tab on the navigation bar. -- Choose a gateway client (these are phone numbers that route your offline message to the internet). +- Choose a routing number (this is the number that routes your offline message to the internet). -- Alternatively, you can select a gateway client from the list that pops up when you hit the send button after composing your message. +- Alternatively, you can select a routing number from the list that appears after you tap Send. -GatewayAvailable -addgatewayclient +Routing Numbers image +addgatewayclient -*Note: If you don’t select one, the app will assign a default gateway for you.* +*Note: If you do not select one, the app assigns a default routing number for you.* **4. Sending messages** - Tap **“Compose New Message”**. -addgatewayclient -addgatewayclient +Messages screen - -- **Fill in the required fields** (recipient email, subject, and message). + +- **Fill in the required fields** (recipient email and message). - Hit **Send** at the top right corner. -- Confirm the gateway client, and that's it.(if the RelaySMS app is set as your default messaging app) +- Confirm the routing number, and that's it (if RelaySMS is your default messaging app). addgatewayclient -*NB: If the RelaySMS app is not set as your default message app, you will need to choose a default messaging app to send your message.* +*NB: If RelaySMS is not your default messaging app, you will be asked to choose one to send.* *Your message is now on its way online, even without internet!* diff --git a/docs/Gateway Clients Guide/GatewayClientsGuide.md b/docs/Gateway Clients Guide/GatewayClientsGuide.md index f6d805ae..0e8cf99e 100644 --- a/docs/Gateway Clients Guide/GatewayClientsGuide.md +++ b/docs/Gateway Clients Guide/GatewayClientsGuide.md @@ -2,28 +2,28 @@ sidebar_position: 1 --- -# Gateway Clients +# Routing Numbers -Gateway Clients are a core part of how RelaySMS works. They are phone numbers or devices located in areas with an active internet connection that act as a bridge between offline users and online platforms. +Routing numbers are a core part of how RelaySMS works. They are phone numbers or devices in areas with active internet connectivity that route messages from offline users to online platforms. -When a user sends a message through RelaySMS without internet access, the message is delivered via SMS to a Gateway Client. The Gateway Client then forwards that message to an online server, where it is processed and published to the user’s selected platform. +When a user sends a message through RelaySMS without internet access, the message is delivered via SMS to a routing number. That number forwards the message to an online server where it is processed and published to the selected platform. -Within the app, Gateway Clients are listed under the Countries tab. Users must select a gateway in a region with internet connectivity to successfully send their messages. +Within the app, routing numbers are listed under the Countries tab. Users should select a number in a region with internet connectivity to successfully send messages. -Gateway Clients can be set up using the DekuSMS app, and expanding their availability across different regions helps improve reliability, reduce costs, and ensure more users can stay connected during internet shutdowns. +Routing numbers can be set up using the DekuSMS app. Expanding availability across regions improves reliability, reduces cost, and helps more users stay connected during internet shutdowns. -# Hosting and Running Gateway Clients Guide +## Hosting and Running a Routing Number -Follow this simple guide to set up and configure a Deku SMS Gateway Client on your Android device. +Follow this guide to set up and configure a Deku SMS routing number on your Android device. -## Requirements for Setting Up a Gateway Client: +### Requirements for Setting Up a Routing Number: -### Android Device: +#### Android Device: - Your device must be able to connect to the internet. - It should have a SIM card capable of receiving SMS messages. -### Internet Connection: +#### Internet Connection: - You will need a reliable internet connection (Wi-Fi or mobile data). - Deku SMS uses very little data, so mobile data is sufficient. @@ -40,13 +40,15 @@ You can download the Deku SMS app from one of the following sources: ### Step 2: Set Deku SMS as Your Default SMS App -GatewayAvailable +GatewayAvailable Once the app is installed, set it as the default SMS app on your Android device. ### Step 3: Configure Message Forwarding -GatewayAvailable +GatewayAvailable +GatewayAvailable + 1. Open the Deku SMS app. 2. Tap on the three dots in the top right corner of the app. @@ -54,19 +56,19 @@ Once the app is installed, set it as the default SMS app on your Android device. ### Step 4: Add a Gateway Server -GatewayAvailable -GatewayAvailable -GatewayAvailable +GatewayAvailable +GatewayAvailable +GatewayAvailable 1. Tap on the menu dots in the top right corner of the routed messages page. -2. Tap on the three dots in the top right corner of the Gateway Clients messages page. +2. Tap on the three dots in the top right corner of the routed messages page. 3. Tap the three dots once more and choose **Add HTTPS Forwarders.** ### Step 5: Fill in the Required Information -GatewayAvailable -GatewayAvailable +GatewayAvailable +GatewayAvailable - Enter the following URL: https://gatewayserver.smswithoutborders.com/v3/publish @@ -77,12 +79,12 @@ https://gatewayserver.smswithoutborders.com/v3/publish ### Step 6: Finalize the Setup -GatewayAvailable +GatewayAvailable 1. Tap **Save** to save your gateway server configuration. -GatewayAvailable +GatewayAvailable -## Your Gateway Client is Now Ready! +## Your Routing Number Is Now Ready -You can now share your number with RelaySMS users. Your Android device will act as a gateway client, helping route messages through the Deku SMS app. \ No newline at end of file +You can now share your number with RelaySMS users. Your Android device will act as a routing number, helping route messages through the Deku SMS app. \ No newline at end of file diff --git a/docs/On-Device Tutorial/On-DeviceToken.md b/docs/On-Device Tutorial/On-DeviceToken.md index 972ab9e2..29c2b26f 100644 --- a/docs/On-Device Tutorial/On-DeviceToken.md +++ b/docs/On-Device Tutorial/On-DeviceToken.md @@ -1,5 +1,6 @@ --- -sidebar_position: 1 +sidebar: false +unlisted: true --- # How to Use the On-Device Token Storage Feature diff --git a/docs/Troubleshooting/RelaySMS.md b/docs/Troubleshooting/RelaySMS.md index 4bae3f0c..644da75e 100644 --- a/docs/Troubleshooting/RelaySMS.md +++ b/docs/Troubleshooting/RelaySMS.md @@ -9,7 +9,7 @@ sidebar_position: 3 ### 1. **Why am I not receiving SMS messages on RelaySMS?** - **Possible causes:** - - Ensure your SMS Gateway client is properly configured. + - Ensure your SMS routing number is properly configured. - Check if your device has sufficient signal for SMS. - Verify that RelaySMS has permission to read and send SMS messages. @@ -31,7 +31,7 @@ sidebar_position: 3 ### 4. **Why is there a delay in sending or receiving messages?** - **Possible causes:** - - Ensure that your SMS Gateway client has an active connection. + - Ensure that your SMS routing number has an active connection. - If you're offline, messages will only be sent when the device reconnects to a network. - Ensure there’s no high traffic or overload on the Vault servers. @@ -53,7 +53,7 @@ sidebar_position: 3 - **Possible causes:** - Check if your message is properly composed and encrypted before sending. - - Make sure that your SMS Gateway client is running properly. + - Make sure that your SMS routing number is running properly. - Verify your OAuth2 tokens and attempt to resend the message. ### 8. **How do I grant SMS permissions for RelaySMS?** diff --git a/docs/Troubleshooting/Troubleshooting-FAQ.md b/docs/Troubleshooting/Troubleshooting-FAQ.md index 7424e027..32554056 100644 --- a/docs/Troubleshooting/Troubleshooting-FAQ.md +++ b/docs/Troubleshooting/Troubleshooting-FAQ.md @@ -59,7 +59,7 @@ sidebar_position: 1 **Issue**: Messages are not publishing **Solutions**: -- Try using a different gateway client. +- Try using a different routing number. - Log out of your account, clear the app's cache and data, and log back in. - If you haven't used the account for a long time, revoke access to the platform and restore it. - Check your SIM card is active and able to send SMS messages. diff --git a/docs/iOS Tutorial/Getting-Started-With-iOS.md b/docs/iOS Tutorial/Getting-Started-With-iOS.md index dbad7ba8..70f356a2 100644 --- a/docs/iOS Tutorial/Getting-Started-With-iOS.md +++ b/docs/iOS Tutorial/Getting-Started-With-iOS.md @@ -23,16 +23,16 @@ RelaySMS enables users to stay connected to their online platforms even when the There are two ways to communicate using the app during an internet shutdown; -**A.** By using your default RelaySMS account(bridges), where u can send an email without the need to sign up or save platforms +**A.** By using Offline RelaySMS Mail, where you can send an email without needing to sign up or save platforms. **B.** By saving access to your desired platforms on the app -### A. Communicating Using RelaySMS Bridges +### A. Communicating Using Offline RelaySMS Mail -*Using Bridges (No sign-up required) & Using Platforms (Sign-up and store access ahead of time)* +*Use Offline RelaySMS Mail (no setup required) or saved platforms (sign-up and save access ahead of time).* -## [1. Using Bridges (No sign-up required)](/docs/Bridges%20Tutorial/Bridges#using-bridges-no-sign-up-required) +## [1. Use Offline RelaySMS Mail (No setup required)](/docs/Bridges%20Tutorial/Bridges) **Step 1: Click the "compose new message" Button** @@ -105,15 +105,15 @@ After composing your message, confirm and send it through your phone’s SMS app add-message GatewayAvailable -**Step 6: Choose a Gateway Client** +**Step 6: Choose a Routing Number** a. Tap the Country tab. b. Pick a number and tap Make Default. -c. You can even add your own gateway client here by tapping Add Number. -d. Alternatively, you can select a gateway client from the list that pops up when you hit the send button after composing your message. +c. You can even add your own routing number here by tapping Add Number. +d. Alternatively, you can select a routing number from the list that pops up when you hit the send button after composing your message. #### 6. Send a message: @@ -127,7 +127,7 @@ d. Alternatively, you can select a gateway client from the list that pops up whe GatewayAvailable -- c. Confirm the gateway client, and that's it.(if the RelaySMS app is set as your default messaging app) +- c. Confirm the routing number, and that's it (if the RelaySMS app is set as your default messaging app). GatewayAvailable diff --git a/docusaurus.config.js b/docusaurus.config.js index 00ab7f3d..c944feff 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -97,7 +97,7 @@ const config = { to: "/docs/iOS Tutorial/Getting-Started-With-iOS", }, { - label: "Setting Up Gateway-Client", + label: "Routing Number Guide", to: "/docs/Gateway Clients Guide/GatewayClientsGuide", }, ], @@ -136,7 +136,7 @@ const config = { to: "/docs/Android Tutorial/Getting-Started-With-Android", }, { - label: "Gateway Client", + label: "Routing Number", to: "/docs/Gateway Clients Guide/GatewayClientsGuide", }, { @@ -169,7 +169,7 @@ const config = { items: [ { label: "Project", - href: "https://github.com/smswithoutborders", + href: "https://smswithoutborders.com", }, { label: "Contribute", diff --git a/i18n/en/code.json b/i18n/en/code.json index e81c6f81..1af52f02 100644 --- a/i18n/en/code.json +++ b/i18n/en/code.json @@ -313,10 +313,10 @@ "message": "Everything you need to set up, use, and understand SMSWithoutBorders Projects" }, "home.gateway.title": { - "message": "Gateway Clients Guide" + "message": "Routing Number Guide" }, "home.gateway.desc": { - "message": "Set up and manage your SMS Gateway" + "message": "Set up and manage your routing numbers" }, "home.ios.title": { "message": "Get Started with iOS" diff --git a/i18n/en/docusaurus-plugin-content-docs/current.json b/i18n/en/docusaurus-plugin-content-docs/current.json index cb110bb4..ce334432 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current.json +++ b/i18n/en/docusaurus-plugin-content-docs/current.json @@ -12,7 +12,7 @@ "description": "The label for category 'Android Tutorial' in sidebar 'tutorialSidebar'" }, "sidebar.tutorialSidebar.category.Gateway Clients Guide": { - "message": "Gateway Clients Guide", + "message": "Routing Number Guide", "description": "The label for category 'Gateway Clients Guide' in sidebar 'tutorialSidebar'" }, "sidebar.tutorialSidebar.category.Troubleshooting": { @@ -23,10 +23,6 @@ "message": "iOS Tutorial", "description": "The label for category 'iOS Tutorial' in sidebar 'tutorialSidebar'" }, - "sidebar.tutorialSidebar.category.Bridges Tutorial": { - "message": "Bridges Tutorial", - "description": "The label for category 'Bridges Tutorial' in sidebar 'tutorialSidebar'" - }, "sidebar.tutorialSidebar.category.On-Device Tutorial": { "message": "On-Device Tutorial", "description": "The label for category 'On-Device Tutorial' in sidebar 'tutorialSidebar'" diff --git a/i18n/en/docusaurus-theme-classic/footer.json b/i18n/en/docusaurus-theme-classic/footer.json index 1b3f032d..ab57a40f 100644 --- a/i18n/en/docusaurus-theme-classic/footer.json +++ b/i18n/en/docusaurus-theme-classic/footer.json @@ -55,9 +55,9 @@ "message": "Getting Started", "description": "The label of footer link with label=Getting Started linking to /docs/Android Tutorial/Getting-Started-With-Android" }, - "link.item.label.Gateway Client": { - "message": "Gateway Client", - "description": "The label of footer link with label=Gateway Client linking to /docs/Gateway Clients Guide/GatewayClientsGuide" + "link.item.label.Routing Number": { + "message": "Routing Number", + "description": "The label of footer link with label=Routing Number linking to /docs/Gateway Clients Guide/GatewayClientsGuide" }, "link.item.label.Issues": { "message": "Issues", diff --git a/i18n/en/docusaurus-theme-classic/navbar.json b/i18n/en/docusaurus-theme-classic/navbar.json index c81560a6..ff0be446 100644 --- a/i18n/en/docusaurus-theme-classic/navbar.json +++ b/i18n/en/docusaurus-theme-classic/navbar.json @@ -43,8 +43,8 @@ "message": "Get Started with iOS", "description": "Navbar item with label Get Started with iOS" }, - "item.label.Setting Up Gateway-Client": { - "message": "Setting Up Gateway-Client", - "description": "Navbar item with label Setting Up Gateway-Client" + "item.label.Routing Number Guide": { + "message": "Routing Number Guide", + "description": "Navbar item with label Routing Number Guide" } } diff --git a/i18n/es/docusaurus-plugin-content-docs/current.json b/i18n/es/docusaurus-plugin-content-docs/current.json index 45ba37a4..c5c0240f 100644 --- a/i18n/es/docusaurus-plugin-content-docs/current.json +++ b/i18n/es/docusaurus-plugin-content-docs/current.json @@ -12,7 +12,7 @@ "description": "The label for category Android Tutorial in sidebar tutorialSidebar" }, "sidebar.tutorialSidebar.category.Gateway Clients Guide": { - "message": "Guía de Clientes de Puerta de Enlace", + "message": "Guía de Números de Enrutamiento", "description": "The label for category Gateway Clients Guide in sidebar tutorialSidebar" }, "sidebar.tutorialSidebar.category.Troubleshooting": { diff --git a/i18n/es/docusaurus-plugin-content-docs/current/Android Tutorial/Getting-Started-With-Android.md b/i18n/es/docusaurus-plugin-content-docs/current/Android Tutorial/Getting-Started-With-Android.md index f1bf1138..6eb8ecf0 100644 --- a/i18n/es/docusaurus-plugin-content-docs/current/Android Tutorial/Getting-Started-With-Android.md +++ b/i18n/es/docusaurus-plugin-content-docs/current/Android Tutorial/Getting-Started-With-Android.md @@ -13,11 +13,11 @@ RelaySMS permite a los usuarios mantenerse conectados a sus plataformas en líne RelaySMS te ayuda a enviar mensajes en línea **sin necesitar Internet**. Funciona de **dos maneras:** -## [1. Usando Bridges (No requiere registro)](/docs/Bridges%20Tutorial/Bridges#using-bridges-no-sign-up-required) +## [1. Usando Offline RelaySMS Mail (Sin configuracion previa)](/docs/Bridges%20Tutorial/Bridges) ## **2. Usando Plataformas (Requiere registro y configuración previa)** -Método ideal para publicar en **Gmail, Twitter o Telegram** durante cortes de Internet usando tus propias cuentas. +Método ideal para publicar en **Gmail, Bluesky o Telegram** durante cortes de Internet usando tus propias cuentas. ### Pasos para usar Plataformas: @@ -49,7 +49,7 @@ Método ideal para publicar en **Gmail, Twitter o Telegram** durante cortes de I - Puedes elegir Gmail, Twitter o Telegram - Toca **Add Platform** -7. **Elegir un Gateway Client** +7. **Elegir un numero de enrutamiento** - Ve a **Country** - Selecciona un número y presiona **Make Default** - También puedes agregar un número propio @@ -58,7 +58,7 @@ Método ideal para publicar en **Gmail, Twitter o Telegram** durante cortes de I - En **Recent**, toca **Compose** - Elige una plataforma - Escribe tu mensaje y presiona **Send** -- Confirma el gateway +- Confirma el numero de enrutamiento *NB: Si RelaySMS no es tu app SMS predeterminada, deberás elegir una.* @@ -82,4 +82,4 @@ La función **Store Tokens On-Device** guarda tus tokens **localmente en tu tel 4. Pega el mensaje 5. La app actualizará el token automáticamente -## [How to Use the On-Device Token Storage Feature](/docs/On-Device%20Tutorial/On-DeviceToken#how-to-use-the-on-device-token-storage-feature) +## [How to Use the On-Device Token Storage Feature](/docs/On-Device%20Tutorial/On-DeviceToken) diff --git a/i18n/es/docusaurus-plugin-content-docs/current/Bridges Tutorial/Bridges.md b/i18n/es/docusaurus-plugin-content-docs/current/Bridges Tutorial/Bridges.md index 4a49eb01..10a8f750 100644 --- a/i18n/es/docusaurus-plugin-content-docs/current/Bridges Tutorial/Bridges.md +++ b/i18n/es/docusaurus-plugin-content-docs/current/Bridges Tutorial/Bridges.md @@ -2,15 +2,15 @@ sidebar_position: 1 --- -# Usar Bridges en la aplicación RelaySMS (No se requiere registro) +# Usar Offline RelaySMS Mail en la aplicacion RelaySMS (Sin configuracion previa) -Aprende a usar la función Bridges en la aplicación RelaySMS. Esta herramienta te permite enviar mensajes de forma segura a plataformas en línea **sin iniciar sesión y sin usar Internet**. Sigue estos pasos para comenzar. +Aprende a usar Offline RelaySMS Mail en la aplicacion RelaySMS. Esta herramienta te permite enviar mensajes de forma segura a plataformas en linea **sin iniciar sesion y sin usar Internet**. Sigue estos pasos para comenzar. --- Esta es la forma más rápida de empezar. La app crea un alias temporal usando tu número de teléfono (por ejemplo: **123456789@relaysms.me**) para enviar correos o tweets **sin almacenar tokens ni iniciar sesión**. -## Pasos para usar la función Bridge: +## Pasos para usar Offline RelaySMS Mail: ### **1. Descarga la aplicación RelaySMS desde:** @@ -36,10 +36,10 @@ Esta es la forma más rápida de empezar. La app crea un alias temporal usando t onboarding2 onboarding2 -### **3. Selecciona un Gateway Client:** +### **3. Selecciona un numero de enrutamiento:** - Pulsa la pestaña 🌍 *País* en la barra de navegación. -- Elige un gateway client (números que envían tu mensaje offline a Internet). +- Elige un numero de enrutamiento (numeros que envian tu mensaje offline a Internet). - También puedes seleccionarlo en la lista que aparece cuando presionas *Enviar* luego de escribir tu mensaje. GatewayAvailable @@ -54,10 +54,10 @@ Esta es la forma más rápida de empezar. La app crea un alias temporal usando t addgatewayclient addgatewayclient -Para los bridges: +Para Offline RelaySMS Mail: - Completa los campos necesarios (correo del destinatario, asunto y mensaje). - Presiona **Enviar** en la esquina superior derecha. -- Confirma el gateway client — y listo (si RelaySMS es tu app SMS predeterminada). +- Confirma el numero de enrutamiento y listo (si RelaySMS es tu app SMS predeterminada). addgatewayclient diff --git a/i18n/es/docusaurus-plugin-content-docs/current/Gateway Clients Guide/GatewayClientsGuide.md b/i18n/es/docusaurus-plugin-content-docs/current/Gateway Clients Guide/GatewayClientsGuide.md index 4f410b13..1d94af59 100644 --- a/i18n/es/docusaurus-plugin-content-docs/current/Gateway Clients Guide/GatewayClientsGuide.md +++ b/i18n/es/docusaurus-plugin-content-docs/current/Gateway Clients Guide/GatewayClientsGuide.md @@ -2,11 +2,11 @@ sidebar_position: 1 --- -# Guía para alojar y ejecutar clientes Gateway +# Guia para alojar y ejecutar numeros de enrutamiento -Siga esta guía sencilla para configurar y establecer un cliente Gateway de Deku SMS en su dispositivo Android. +Siga esta guia sencilla para configurar y establecer un numero de enrutamiento de Deku SMS en su dispositivo Android. -## Requisitos para configurar un cliente Gateway: +## Requisitos para configurar un numero de enrutamiento: ### Dispositivo Android: Su dispositivo debe poder conectarse a Internet. @@ -45,7 +45,7 @@ En el menú desplegable, seleccione Message Forwarding. GatewayAvailable Toque los puntos del menú en la esquina superior derecha de la página de mensajes enrutados. -Toque los tres puntos en la esquina superior derecha de la página de mensajes de clientes Gateway. +Toque los tres puntos en la esquina superior derecha de la pagina de mensajes enrutados. Toque nuevamente los tres puntos y elija Add HTTPS Forwarders. ### Paso 5: Completar la información requerida @@ -67,6 +67,6 @@ Toque Save para guardar la configuración de su servidor Gateway. GatewayAvailable -## ¡Su cliente Gateway ahora está listo! +## Su numero de enrutamiento ahora esta listo -Ahora puede compartir su número con usuarios de RelaySMS. Su dispositivo Android actuará como un cliente Gateway, ayudando a enrutar mensajes a través de la aplicación Deku SMS. \ No newline at end of file +Ahora puede compartir su numero con usuarios de RelaySMS. Su dispositivo Android actuara como un numero de enrutamiento, ayudando a enrutar mensajes a traves de la aplicacion Deku SMS. \ No newline at end of file diff --git a/i18n/es/docusaurus-plugin-content-docs/current/iOS Tutorial/Getting-Started-With-iOS.md b/i18n/es/docusaurus-plugin-content-docs/current/iOS Tutorial/Getting-Started-With-iOS.md index 2cd464cc..dc74e84d 100644 --- a/i18n/es/docusaurus-plugin-content-docs/current/iOS Tutorial/Getting-Started-With-iOS.md +++ b/i18n/es/docusaurus-plugin-content-docs/current/iOS Tutorial/Getting-Started-With-iOS.md @@ -21,16 +21,16 @@ RelaySMS permite a los usuarios mantenerse conectados a sus plataformas en líne Hay dos formas de comunicarte con la app durante un corte de Internet: -**A.** Usando tu cuenta predeterminada de RelaySMS (bridges), donde puedes enviar un correo sin necesidad de registro o guardar plataformas +**A.** Usando Offline RelaySMS Mail, donde puedes enviar un correo sin necesidad de registro o guardar plataformas **B.** Guardando el acceso a tus plataformas deseadas en la app -### A. Comunicarse usando los bridges de RelaySMS +### A. Comunicarse usando Offline RelaySMS Mail -*Uso de bridges (sin registro) y uso de plataformas (registro y acceso guardado previamente)* +*Uso de Offline RelaySMS Mail (sin configuracion previa) y uso de plataformas (registro y acceso guardado previamente)* -## [1. Uso de bridges (sin necesidad de registro)](/docs/Bridges%20Tutorial/Bridges#using-bridges-no-sign-up-required) +## [1. Uso de Offline RelaySMS Mail (sin configuracion previa)](/docs/Bridges%20Tutorial/Bridges) **Paso 1: Pulsa el botón "redactar nuevo mensaje"** sign_in diff --git a/i18n/fa/docusaurus-plugin-content-docs/current.json b/i18n/fa/docusaurus-plugin-content-docs/current.json index 702d3d4c..42f6c33d 100644 --- a/i18n/fa/docusaurus-plugin-content-docs/current.json +++ b/i18n/fa/docusaurus-plugin-content-docs/current.json @@ -12,7 +12,7 @@ "description": "The label for category Android Tutorial in sidebar tutorialSidebar" }, "sidebar.tutorialSidebar.category.Gateway Clients Guide": { - "message": "راهنمای مشتریان دروازه", + "message": "راهنمای شماره های مسیریابی", "description": "The label for category Gateway Clients Guide in sidebar tutorialSidebar" }, "sidebar.tutorialSidebar.category.Troubleshooting": { diff --git a/i18n/fa/docusaurus-plugin-content-docs/current/Android Tutorial/Getting-Started-With-Android.md b/i18n/fa/docusaurus-plugin-content-docs/current/Android Tutorial/Getting-Started-With-Android.md index 196933ce..1663a6fd 100644 --- a/i18n/fa/docusaurus-plugin-content-docs/current/Android Tutorial/Getting-Started-With-Android.md +++ b/i18n/fa/docusaurus-plugin-content-docs/current/Android Tutorial/Getting-Started-With-Android.md @@ -13,11 +13,11 @@ RelaySMS به شما امکان می‌دهد حتی زمانی که اینتر RelaySMS کمک می‌کند **بدون نیاز به اینترنت** پیام‌های آنلاین ارسال کنید. این برنامه به **دو روش** کار می‌کند: -## [1. استفاده از Bridge ها (بدون نیاز به ثبت‌نام)](/docs/Bridges%20Tutorial/Bridges#using-bridges-no-sign-up-required) +## [1. استفاده از Offline RelaySMS Mail (بدون نیاز به تنظیمات)](/docs/Bridges%20Tutorial/Bridges) ## **2. استفاده از پلتفرم‌ها (نیازمند ثبت‌نام و تنظیمات اولیه)** -این روش مناسب زمانی است که می‌خواهید در زمان قطع اینترنت در پلتفرم‌هایی مانند **Gmail ،Twitter یا Telegram** با حساب خود پست منتشر کنید. +این روش مناسب زمانی است که می‌خواهید در زمان قطع اینترنت در پلتفرم‌هایی مانند **Gmail، Bluesky یا Telegram** با حساب خود پست منتشر کنید. ### مراحل استفاده از پلتفرم‌ها: @@ -46,7 +46,7 @@ RelaySMS کمک می‌کند **بدون نیاز به اینترنت** پیام - انتخاب Gmail, Twitter یا Telegram - انتخاب **Add Platform** -7. **انتخاب Gateway Client** +7. **انتخاب شماره مسیریابی** - رفتن به تب **Country** - انتخاب یک شماره و زدن **Make Default** - امکان افزودن شماره اختصاصی نیز وجود دارد @@ -55,7 +55,7 @@ RelaySMS کمک می‌کند **بدون نیاز به اینترنت** پیام - در صفحه **Recent** روی **Compose** بزنید - پلتفرم را انتخاب کنید - پیام را بنویسید و **Send** را بزنید -- Gateway را تأیید کنید +- شماره مسیریابی را تأیید کنید *نکته: اگر RelaySMS پیام‌رسان پیش‌فرض شما نیست، باید یکی را انتخاب کنید.* @@ -79,4 +79,4 @@ RelaySMS کمک می‌کند **بدون نیاز به اینترنت** پیام 4. پیام را جای‌گذاری کنید 5. برنامه به‌طور خودکار توکن را به‌روزرسانی می‌کند -## [How to Use the On-Device Token Storage Feature](/docs/On-Device%20Tutorial/On-DeviceToken#how-to-use-the-on-device-token-storage-feature) +## [How to Use the On-Device Token Storage Feature](/docs/On-Device%20Tutorial/On-DeviceToken) diff --git a/i18n/fa/docusaurus-plugin-content-docs/current/Bridges Tutorial/Bridges.md b/i18n/fa/docusaurus-plugin-content-docs/current/Bridges Tutorial/Bridges.md index cf6d3bf8..01c88c33 100644 --- a/i18n/fa/docusaurus-plugin-content-docs/current/Bridges Tutorial/Bridges.md +++ b/i18n/fa/docusaurus-plugin-content-docs/current/Bridges Tutorial/Bridges.md @@ -2,16 +2,16 @@ sidebar_position: 1 --- -# استفاده از بریج‌ها در اپلیکیشن RelaySMS (بدون نیاز به ثبت‌نام) +# استفاده از Offline RelaySMS Mail در اپلیکیشن RelaySMS (بدون نیاز به تنظیمات) -در این بخش یاد می‌گیرید چگونه از قابلیت **بریج‌ها (Bridges)** در اپلیکیشن RelaySMS استفاده کنید. این ابزار به شما اجازه می‌دهد پیام‌ها را به صورت امن به پلتفرم‌های آنلاین ارسال کنید **بدون اینکه وارد حساب شوید یا از اینترنت استفاده کنید**. مراحل زیر را دنبال کنید. +در این بخش یاد می‌گیرید چگونه از **Offline RelaySMS Mail** در اپلیکیشن RelaySMS استفاده کنید. این ابزار به شما اجازه می‌دهد پیام‌ها را به صورت امن به پلتفرم‌های آنلاین ارسال کنید **بدون اینکه وارد حساب شوید یا از اینترنت استفاده کنید**. مراحل زیر را دنبال کنید. --- این سریع‌ترین روش برای شروع است. اپلیکیشن یک آدرس موقت با استفاده از شماره تلفن شما ایجاد می‌کند (مثلاً: **123456789@relaysms.me**) تا ایمیل یا توییت را **بدون ذخیره‌سازی توکن‌ها یا ورود به حساب** ارسال کند. -## مراحل استفاده از قابلیت بریج: +## مراحل استفاده از Offline RelaySMS Mail: ### **1. دانلود اپلیکیشن RelaySMS از:** @@ -37,10 +37,10 @@ sidebar_position: 1 onboarding2 onboarding2 -### **3. انتخاب Gateway Client :** +### **3. انتخاب شماره مسیریابی:** - روی تب 🌍 *کشور* در نوار پایین برنامه ضربه بزنید. -- یک Gateway Client انتخاب کنید (این شماره‌ها پیام آفلاین شما را به اینترنت منتقل می‌کنند). +- یک شماره مسیریابی انتخاب کنید (این شماره‌ها پیام آفلاین شما را به اینترنت منتقل می‌کنند). - همچنین می‌توانید بعد از نوشتن پیام و فشار دادن دکمه ارسال، از لیستی که ظاهر می‌شود یکی را انتخاب کنید. GatewayAvailable @@ -55,10 +55,10 @@ sidebar_position: 1 addgatewayclient addgatewayclient -برای ارسال پیام از طریق بریج: +برای ارسال پیام از طریق Offline RelaySMS Mail: - فیلدهای لازم (ایمیل گیرنده، موضوع، متن پیام) را پر کنید. - روی **ارسال** در گوشه بالا سمت راست بزنید. -- Gateway Client را تأیید کنید — همین! (اگر RelaySMS برنامه پیش‌فرض پیام‌رسان باشد) +- شماره مسیریابی را تأیید کنید — همین! (اگر RelaySMS برنامه پیش‌فرض پیام‌رسان باشد) addgatewayclient diff --git a/i18n/fa/docusaurus-plugin-content-docs/current/Gateway Clients Guide/GatewayClientsGuide.md b/i18n/fa/docusaurus-plugin-content-docs/current/Gateway Clients Guide/GatewayClientsGuide.md index 2e378ec3..8fa08ddf 100644 --- a/i18n/fa/docusaurus-plugin-content-docs/current/Gateway Clients Guide/GatewayClientsGuide.md +++ b/i18n/fa/docusaurus-plugin-content-docs/current/Gateway Clients Guide/GatewayClientsGuide.md @@ -2,11 +2,11 @@ sidebar_position: 1 --- -# راهنمای میزبانی و اجرای کلاینت‌های Gateway +# راهنمای میزبانی و اجرای شماره های مسیریابی -این راهنمای ساده را دنبال کنید تا یک کلاینت Gateway از Deku SMS را روی دستگاه اندرویدی خود راه‌اندازی و پیکربندی کنید. +این راهنمای ساده را دنبال کنید تا یک شماره مسیریابی Deku SMS را روی دستگاه اندرویدی خود راه‌اندازی و پیکربندی کنید. -## پیش‌نیازهای راه‌اندازی یک کلاینت Gateway: +## پیش‌نیازهای راه‌اندازی یک شماره مسیریابی: ### دستگاه اندروید: دستگاه شما باید قادر به اتصال به اینترنت باشد. @@ -45,7 +45,7 @@ Deku SMS از داده بسیار کمی استفاده می‌کند، بناب GatewayAvailable روی نقاط منو در گوشه بالا سمت راست صفحه پیام‌های مسیردهی شده ضربه بزنید. -روی سه نقطه در گوشه بالا سمت راست صفحه پیام‌های کلاینت Gateway ضربه بزنید. +روی سه نقطه در گوشه بالا سمت راست صفحه پیام‌های مسیریابی شده ضربه بزنید. دوباره روی سه نقطه ضربه بزنید و گزینه Add HTTPS Forwarders را انتخاب کنید. ### مرحله 5: وارد کردن اطلاعات مورد نیاز @@ -67,6 +67,6 @@ Tag: یک نام برای سرور Gateway خود وارد کنید. GatewayAvailable -## کلاینت Gateway شما اکنون آماده است! +## شماره مسیریابی شما اکنون آماده است -اکنون می‌توانید شماره خود را با کاربران RelaySMS به اشتراک بگذارید. دستگاه اندرویدی شما به عنوان یک کلاینت Gateway عمل خواهد کرد و به مسیریابی پیام‌ها از طریق برنامه Deku SMS کمک می‌کند. \ No newline at end of file +اکنون می‌توانید شماره خود را با کاربران RelaySMS به اشتراک بگذارید. دستگاه اندرویدی شما به عنوان یک شماره مسیریابی عمل خواهد کرد و به مسیریابی پیام‌ها از طریق برنامه Deku SMS کمک می‌کند. \ No newline at end of file diff --git a/i18n/fa/docusaurus-plugin-content-docs/current/iOS Tutorial/Getting-Started-With-iOS.md b/i18n/fa/docusaurus-plugin-content-docs/current/iOS Tutorial/Getting-Started-With-iOS.md index 6311f53c..35086674 100644 --- a/i18n/fa/docusaurus-plugin-content-docs/current/iOS Tutorial/Getting-Started-With-iOS.md +++ b/i18n/fa/docusaurus-plugin-content-docs/current/iOS Tutorial/Getting-Started-With-iOS.md @@ -21,16 +21,16 @@ RelaySMS به کاربران اجازه می‌دهد حتی زمانی که ب دو روش برای ارتباط با اپ در زمان قطع اینترنت وجود دارد: -**A.** با استفاده از حساب پیش‌فرض RelaySMS (bridges)، می‌توانید بدون نیاز به ثبت‌نام یا ذخیره پلتفرم‌ها ایمیل ارسال کنید +**A.** با استفاده از Offline RelaySMS Mail می‌توانید بدون نیاز به ثبت‌نام یا ذخیره پلتفرم‌ها ایمیل ارسال کنید **B.** با ذخیره دسترسی به پلتفرم‌های مورد نظر در اپ -### A. ارتباط با bridges RelaySMS +### A. ارتباط با Offline RelaySMS Mail -*استفاده از bridges (بدون ثبت‌نام) & استفاده از پلتفرم‌ها (ثبت‌نام و ذخیره قبلی)* +*استفاده از Offline RelaySMS Mail (بدون نیاز به تنظیمات) و استفاده از پلتفرم‌ها (ثبت‌نام و ذخیره قبلی)* -## [1. استفاده از bridges (بدون ثبت‌نام)](/docs/Bridges%20Tutorial/Bridges#using-bridges-no-sign-up-required) +## [1. استفاده از Offline RelaySMS Mail (بدون نیاز به تنظیمات)](/docs/Bridges%20Tutorial/Bridges) **مرحله ۱: کلیک روی دکمه "نوشتن پیام جدید"** sign_in diff --git a/i18n/fr/docusaurus-plugin-content-docs/current.json b/i18n/fr/docusaurus-plugin-content-docs/current.json index e304c2af..9c8ff894 100644 --- a/i18n/fr/docusaurus-plugin-content-docs/current.json +++ b/i18n/fr/docusaurus-plugin-content-docs/current.json @@ -12,7 +12,7 @@ "description": "L'étiquette pour la catégorie Tutoriel Android dans la barre latérale tutorialSidebar" }, "sidebar.tutorialSidebar.category.Gateway Clients Guide": { - "message": "Guide des clients de la passerelle", + "message": "Guide des numeros de routage", "description": "L'étiquette pour la catégorie Guide des clients de la passerelle dans la barre latérale tutorialSidebar" }, "sidebar.tutorialSidebar.category.Troubleshooting": { diff --git a/i18n/fr/docusaurus-plugin-content-docs/current/Android Tutorial/Getting-Started-With-Android.md b/i18n/fr/docusaurus-plugin-content-docs/current/Android Tutorial/Getting-Started-With-Android.md index 5b4e819d..0d7bbdda 100644 --- a/i18n/fr/docusaurus-plugin-content-docs/current/Android Tutorial/Getting-Started-With-Android.md +++ b/i18n/fr/docusaurus-plugin-content-docs/current/Android Tutorial/Getting-Started-With-Android.md @@ -13,11 +13,11 @@ RelaySMS permet aux utilisateurs de rester connectés à leurs plateformes en li RelaySMS vous aide à envoyer des messages en ligne **sans avoir besoin d’Internet**. Il fonctionne de **deux manières :** -## [1. Utiliser des Bridges (Aucune inscription requise)](/docs/Bridges%20Tutorial/Bridges#using-bridges-no-sign-up-required) +## [1. Utiliser Offline RelaySMS Mail (Aucune configuration requise)](/docs/Bridges%20Tutorial/Bridges) ## **2. Utiliser des plateformes (Inscription et configuration nécessaire à l’avance)** -Cette méthode est idéale si vous souhaitez publier sur des plateformes comme **Gmail, Twitter ou Telegram** pendant des coupures d’Internet en utilisant vos propres comptes. +Cette méthode est idéale si vous souhaitez publier sur des plateformes comme **Gmail, Bluesky ou Telegram** pendant des coupures d’Internet en utilisant vos propres comptes. ### Étapes pour utiliser la fonctionnalité Plateforme : @@ -52,7 +52,7 @@ Appuyez sur **Login**, entrez vos informations et le code Recaptcha. - Choisissez Gmail, Twitter ou Telegram - Appuyez sur **Add Platform** -7. **Choisir un Gateway Client :** +7. **Choisir un numero de routage :** - Ouvrez l’onglet **Country** - Sélectionnez un numéro et appuyez sur **Make Default** - Vous pouvez ajouter votre propre gateway via **Add Number** @@ -61,7 +61,7 @@ Appuyez sur **Login**, entrez vos informations et le code Recaptcha. - Sur la page **Recent**, appuyez sur l’icône **Compose** - Choisissez une plateforme sauvegardée - Rédigez votre message puis appuyez sur **Send** -- Confirmez le client Gateway +- Confirmez le numero de routage *NB : Si RelaySMS n’est pas votre application SMS par défaut, il vous sera demandé d’en choisir une.* @@ -85,4 +85,4 @@ La fonction **Store Tokens On-Device** stocke vos jetons d’accès **sur votre 4. Collez le SMS 5. Le jeton sera extrait automatiquement. -## [How to Use the On-Device Token Storage Feature](/docs/On-Device%20Tutorial/On-DeviceToken#how-to-use-the-on-device-token-storage-feature) +## [How to Use the On-Device Token Storage Feature](/docs/On-Device%20Tutorial/On-DeviceToken) diff --git a/i18n/fr/docusaurus-plugin-content-docs/current/Bridges Tutorial/Bridges.md b/i18n/fr/docusaurus-plugin-content-docs/current/Bridges Tutorial/Bridges.md index c7b88091..095c5fcb 100644 --- a/i18n/fr/docusaurus-plugin-content-docs/current/Bridges Tutorial/Bridges.md +++ b/i18n/fr/docusaurus-plugin-content-docs/current/Bridges Tutorial/Bridges.md @@ -2,15 +2,15 @@ sidebar_position: 1 --- -# Utiliser les Bridges dans l’application RelaySMS (Aucune inscription requise) +# Utiliser Offline RelaySMS Mail dans l’application RelaySMS (Aucune configuration requise) -Découvrez comment utiliser la fonctionnalité Bridges dans l’application RelaySMS. Cet outil vous permet d’envoyer des messages en toute sécurité vers des plateformes en ligne **sans vous connecter et sans utiliser Internet**. Suivez ces étapes pour commencer ! +Découvrez comment utiliser Offline RelaySMS Mail dans l’application RelaySMS. Cet outil vous permet d’envoyer des messages en toute sécurité vers des plateformes en ligne **sans vous connecter et sans utiliser Internet**. Suivez ces étapes pour commencer. --- C’est la manière la plus rapide de débuter. L’application crée un alias temporaire utilisant votre numéro de téléphone (ex. : **123456789@relaysms.me**) pour envoyer des emails ou tweets **sans stocker de jetons ni se connecter**. -## Étapes pour utiliser la fonctionnalité Bridge : +## Étapes pour utiliser Offline RelaySMS Mail : ### **1. Téléchargez l’application RelaySMS depuis :** @@ -36,11 +36,11 @@ C’est la manière la plus rapide de débuter. L’application crée un alias t onboarding2 onboarding2 -### **3. Sélectionnez un Gateway Client :** +### **3. Sélectionnez un numero de routage :** - Appuyez sur l’onglet 🌍 *Pays* dans la barre de navigation. -- Choisissez un gateway client (ce sont des numéros qui transmettent votre message hors-ligne vers Internet). -- Vous pouvez aussi sélectionner un gateway client dans la liste qui s’affiche lorsque vous appuyez sur *Envoyer* après avoir rédigé un message. +- Choisissez un numero de routage (ce sont des numéros qui transmettent votre message hors-ligne vers Internet). +- Vous pouvez aussi sélectionner un numero de routage dans la liste qui s’affiche lorsque vous appuyez sur *Envoyer* après avoir rédigé un message. GatewayAvailable addgatewayclient @@ -54,10 +54,10 @@ C’est la manière la plus rapide de débuter. L’application crée un alias t addgatewayclient addgatewayclient -Pour les bridges : +Pour Offline RelaySMS Mail : - Remplissez les champs requis (email du destinataire, objet et message). - Appuyez sur **Envoyer** en haut à droite. -- Confirmez le gateway client, et c’est tout (si RelaySMS est votre application SMS par défaut). +- Confirmez le numero de routage, et c’est tout (si RelaySMS est votre application SMS par défaut). addgatewayclient diff --git a/i18n/fr/docusaurus-plugin-content-docs/current/Gateway Clients Guide/GatewayClientsGuide.md b/i18n/fr/docusaurus-plugin-content-docs/current/Gateway Clients Guide/GatewayClientsGuide.md index 1002088c..22177438 100644 --- a/i18n/fr/docusaurus-plugin-content-docs/current/Gateway Clients Guide/GatewayClientsGuide.md +++ b/i18n/fr/docusaurus-plugin-content-docs/current/Gateway Clients Guide/GatewayClientsGuide.md @@ -3,11 +3,11 @@ sidebar_position: 1 --- -# Guide d’hébergement et d’exécution des clients Gateway +# Guide d’hebergement et d’execution des numeros de routage -Suivez ce guide simple pour configurer et mettre en place un client Gateway Deku SMS sur votre appareil Android. +Suivez ce guide simple pour configurer et mettre en place un numero de routage Deku SMS sur votre appareil Android. -## Exigences pour la configuration d’un client Gateway : +## Exigences pour la configuration d’un numero de routage : ### Appareil Android : Votre appareil doit pouvoir se connecter à Internet. @@ -46,7 +46,7 @@ Dans le menu déroulant, sélectionnez Transfert de messages. GatewayAvailable Appuyez sur les points de menu en haut à droite de la page des messages routés. -Appuyez sur les trois points en haut à droite de la page des messages des clients Gateway. +Appuyez sur les trois points en haut a droite de la page des messages routes. Appuyez à nouveau sur les trois points et choisissez Ajouter des forwarders HTTPS. ### Étape 5 : Remplir les informations requises @@ -68,6 +68,6 @@ Appuyez sur Enregistrer pour sauvegarder la configuration de votre serveur Gatew GatewayAvailable -## Votre client Gateway est maintenant prêt ! +## Votre numero de routage est maintenant pret -Vous pouvez maintenant partager votre numéro avec les utilisateurs de RelaySMS. Votre appareil Android agira comme un client Gateway, aidant à acheminer les messages via l’application Deku SMS. \ No newline at end of file +Vous pouvez maintenant partager votre numero avec les utilisateurs de RelaySMS. Votre appareil Android agira comme un numero de routage, aidant a acheminer les messages via l’application Deku SMS. \ No newline at end of file diff --git a/i18n/fr/docusaurus-plugin-content-docs/current/iOS Tutorial/Getting-Started-With-iOS.md b/i18n/fr/docusaurus-plugin-content-docs/current/iOS Tutorial/Getting-Started-With-iOS.md index afd19e67..6c4f07b1 100644 --- a/i18n/fr/docusaurus-plugin-content-docs/current/iOS Tutorial/Getting-Started-With-iOS.md +++ b/i18n/fr/docusaurus-plugin-content-docs/current/iOS Tutorial/Getting-Started-With-iOS.md @@ -21,16 +21,16 @@ RelaySMS permet aux utilisateurs de rester connectés à leurs plateformes en li Il y a deux façons de communiquer avec l’app en cas de panne Internet : -**A.** Avec votre compte RelaySMS par défaut (bridges), vous pouvez envoyer un e‑mail sans vous inscrire ni sauvegarder des plateformes +**A.** Avec Offline RelaySMS Mail, vous pouvez envoyer un e‑mail sans vous inscrire ni sauvegarder des plateformes **B.** En sauvegardant l’accès à vos plateformes souhaitées dans l’app -### A. Communiquer avec les bridges RelaySMS +### A. Communiquer avec Offline RelaySMS Mail -*Utilisation des bridges (sans inscription) & utilisation des plateformes (inscription et enregistrement préalables)* +*Utilisation de Offline RelaySMS Mail (sans configuration) et utilisation des plateformes (inscription et enregistrement préalables)* -## [1. Utilisation des bridges (sans inscription préalable)](/docs/Bridges%20Tutorial/Bridges#using-bridges-no-sign-up-required) +## [1. Utilisation de Offline RelaySMS Mail (sans configuration)](/docs/Bridges%20Tutorial/Bridges) **Étape 1 : Cliquez sur le bouton "composer un nouveau message"** sign_in diff --git a/sidebars.js b/sidebars.js index 33275803..bcf1acad 100644 --- a/sidebars.js +++ b/sidebars.js @@ -13,21 +13,49 @@ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { - // By default, Docusaurus generates a sidebar from the docs folder structure - tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], - - // But you can create a sidebar manually - /* tutorialSidebar: [ - 'intro', - 'hello', { type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], + label: 'Android Tutorial', + items: [ + 'Android Tutorial/Getting-Started-With-Android', + 'Android Tutorial/Step-1-Download-the-App', + 'Android Tutorial/Step-2-Onboarding', + 'Android Tutorial/Step-3-Save-Platforms', + 'Android Tutorial/Step-4-Back-Up-and-Restore', + 'Android Tutorial/Step-5-Sending-a-Message', + 'Android Tutorial/Step-6-Routing-Numbers', + ], + }, + // { + // type: 'category', + // label: 'Gateway Clients Guide', + // items: ['Gateway Clients Guide/GatewayClientsGuide'], + // }, + { + type: 'category', + label: 'iOS Tutorial', + items: ['iOS Tutorial/Getting-Started-With-iOS'], + }, + // { + // type: 'category', + // label: 'On-Device Tutorial', + // items: ['On-Device Tutorial/On-DeviceToken'], + // }, + { + type: 'category', + label: 'Technical Documentation', + items: ['Technical Documentation/Coming-Soon'], + }, + { + type: 'category', + label: 'Troubleshooting', + items: [ + 'Troubleshooting/RelaySMS', + 'Troubleshooting/Troubleshooting-FAQ', + ], }, ], - */ }; export default sidebars; diff --git a/src/css/custom.css b/src/css/custom.css index 1ad35d88..946b6bb8 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -20,6 +20,8 @@ h1, h2, h3 { :root { --ifm-font-family-base: "Ubuntu", system-ui, sans-serif; --ifm-heading-font-family: "Unbounded", system-ui, sans-serif; + --ifm-h1-font-size: 1.5rem; + --ifm-h2-font-size: 1rem; --ifm-color-primary: #1e40af; --ifm-color-primary-dark: #1d4ed8; @@ -28,6 +30,12 @@ h1, h2, h3 { --ifm-code-font-size: 95%; } +.markdown > h1 { + font-size: 1.5rem; + line-height: 1.2; + margin-bottom: 1rem; +} + .navbar { position: fixed; top: 0; diff --git a/src/pages/index.js b/src/pages/index.js index 965656f3..5a09b01d 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -1,85 +1,6 @@ import React from "react"; -import Link from "@docusaurus/Link"; -import Layout from "@theme/Layout"; -import useDocusaurusContext from "@docusaurus/useDocusaurusContext"; -import SwobLogo from "../../static/logo-icon-light.png"; -import Translate from "@docusaurus/Translate"; -import styles from "./index.module.css"; - -function HomepageHeader() { - return ( -
-
- Swob logo -

- SMSWithoutBorders Documentation -

-

- - Everything you need to set up, use, and understand SMSWithoutBorders Projects - -

- -
- -
-
- Gateway Clients Guide -
-
- Set up and manage your SMS Gateway Clients -
-
- - -
- -
- Get Started with iOS -
-
- Setup RelaySMS on iPhone -
- - - -
- Get Started with Android -
-
- Setup RelaySMS on Android -
- - - -
- Troubleshooting Guide -
-
- Fix common issues -
- - - -
- Technical Docs -
-
- APIs and system details -
- -
-
-
-
- ); -} +import { Redirect } from "@docusaurus/router"; export default function Home() { - const { siteConfig } = useDocusaurusContext(); - return ( - - - - ); + return ; } \ No newline at end of file diff --git a/static/mockup/1000000323-portrait.png b/static/mockup/1000000323-portrait.png new file mode 100644 index 00000000..21949daf Binary files /dev/null and b/static/mockup/1000000323-portrait.png differ diff --git a/static/mockup/Deku/1.png b/static/mockup/Deku/1.png new file mode 100644 index 00000000..f28d4ec9 Binary files /dev/null and b/static/mockup/Deku/1.png differ diff --git a/static/mockup/Deku/10.png b/static/mockup/Deku/10.png new file mode 100644 index 00000000..25656ae5 Binary files /dev/null and b/static/mockup/Deku/10.png differ diff --git a/static/mockup/Deku/2.png b/static/mockup/Deku/2.png new file mode 100644 index 00000000..f4d63379 Binary files /dev/null and b/static/mockup/Deku/2.png differ diff --git a/static/mockup/Deku/3.png b/static/mockup/Deku/3.png new file mode 100644 index 00000000..19b2b46a Binary files /dev/null and b/static/mockup/Deku/3.png differ diff --git a/static/mockup/Deku/4.png b/static/mockup/Deku/4.png new file mode 100644 index 00000000..102d3d7a Binary files /dev/null and b/static/mockup/Deku/4.png differ diff --git a/static/mockup/Deku/5.png b/static/mockup/Deku/5.png new file mode 100644 index 00000000..44322ad9 Binary files /dev/null and b/static/mockup/Deku/5.png differ diff --git a/static/mockup/Deku/6.png b/static/mockup/Deku/6.png new file mode 100644 index 00000000..3ae21154 Binary files /dev/null and b/static/mockup/Deku/6.png differ diff --git a/static/mockup/Deku/7.png b/static/mockup/Deku/7.png new file mode 100644 index 00000000..1e48d9be Binary files /dev/null and b/static/mockup/Deku/7.png differ diff --git a/static/mockup/Deku/8.png b/static/mockup/Deku/8.png new file mode 100644 index 00000000..2dfaf410 Binary files /dev/null and b/static/mockup/Deku/8.png differ diff --git a/static/mockup/Deku/9.png b/static/mockup/Deku/9.png new file mode 100644 index 00000000..8e6e3edb Binary files /dev/null and b/static/mockup/Deku/9.png differ diff --git a/static/mockup/accounts-saved.png b/static/mockup/accounts-saved.png new file mode 100644 index 00000000..1a883f51 Binary files /dev/null and b/static/mockup/accounts-saved.png differ diff --git a/static/mockup/add-routing-number.png b/static/mockup/add-routing-number.png new file mode 100644 index 00000000..c21621f1 Binary files /dev/null and b/static/mockup/add-routing-number.png differ diff --git a/static/mockup/backup-1.png b/static/mockup/backup-1.png new file mode 100644 index 00000000..ba3cda2b Binary files /dev/null and b/static/mockup/backup-1.png differ diff --git a/static/mockup/backup-2.png b/static/mockup/backup-2.png new file mode 100644 index 00000000..ad448339 Binary files /dev/null and b/static/mockup/backup-2.png differ diff --git a/static/mockup/backup-3.png b/static/mockup/backup-3.png new file mode 100644 index 00000000..3adcd440 Binary files /dev/null and b/static/mockup/backup-3.png differ diff --git a/static/mockup/backup-4.png b/static/mockup/backup-4.png new file mode 100644 index 00000000..d20e4787 Binary files /dev/null and b/static/mockup/backup-4.png differ diff --git a/static/mockup/backup-5.png b/static/mockup/backup-5.png new file mode 100644 index 00000000..fc4fa288 Binary files /dev/null and b/static/mockup/backup-5.png differ diff --git a/static/mockup/bluesky-accounts.png b/static/mockup/bluesky-accounts.png new file mode 100644 index 00000000..5bf1f281 Binary files /dev/null and b/static/mockup/bluesky-accounts.png differ diff --git a/static/mockup/compose-email-image.png b/static/mockup/compose-email-image.png new file mode 100644 index 00000000..74d32e8f Binary files /dev/null and b/static/mockup/compose-email-image.png differ diff --git a/static/mockup/compose-email.png b/static/mockup/compose-email.png new file mode 100644 index 00000000..5b3068c1 Binary files /dev/null and b/static/mockup/compose-email.png differ diff --git a/static/mockup/compose-no-platforms.png b/static/mockup/compose-no-platforms.png new file mode 100644 index 00000000..8d99653c Binary files /dev/null and b/static/mockup/compose-no-platforms.png differ diff --git a/static/mockup/compose-telegram.png b/static/mockup/compose-telegram.png new file mode 100644 index 00000000..fe3bb733 Binary files /dev/null and b/static/mockup/compose-telegram.png differ diff --git a/static/mockup/compose.png b/static/mockup/compose.png new file mode 100644 index 00000000..399d7d88 Binary files /dev/null and b/static/mockup/compose.png differ diff --git a/static/mockup/compress-image.png b/static/mockup/compress-image.png new file mode 100644 index 00000000..52cbeaa2 Binary files /dev/null and b/static/mockup/compress-image.png differ diff --git a/static/mockup/enter-telgram-number.png b/static/mockup/enter-telgram-number.png new file mode 100644 index 00000000..f563cbc6 Binary files /dev/null and b/static/mockup/enter-telgram-number.png differ diff --git a/static/mockup/gmail-accounts.png b/static/mockup/gmail-accounts.png new file mode 100644 index 00000000..76225dc1 Binary files /dev/null and b/static/mockup/gmail-accounts.png differ diff --git a/static/mockup/inbox-empty.png b/static/mockup/inbox-empty.png new file mode 100644 index 00000000..a36ccbc5 Binary files /dev/null and b/static/mockup/inbox-empty.png differ diff --git a/static/mockup/inbox-menu-open.png b/static/mockup/inbox-menu-open.png new file mode 100644 index 00000000..c3e165be Binary files /dev/null and b/static/mockup/inbox-menu-open.png differ diff --git a/static/mockup/mastodon-accounts.png b/static/mockup/mastodon-accounts.png new file mode 100644 index 00000000..4911de01 Binary files /dev/null and b/static/mockup/mastodon-accounts.png differ diff --git a/static/mockup/no-platform.png b/static/mockup/no-platform.png new file mode 100644 index 00000000..ef67d29d Binary files /dev/null and b/static/mockup/no-platform.png differ diff --git a/static/mockup/oboarding-1.png b/static/mockup/oboarding-1.png new file mode 100644 index 00000000..c98b75bc Binary files /dev/null and b/static/mockup/oboarding-1.png differ diff --git a/static/mockup/oboarding-2.png b/static/mockup/oboarding-2.png new file mode 100644 index 00000000..e9352b83 Binary files /dev/null and b/static/mockup/oboarding-2.png differ diff --git a/static/mockup/oboarding-3.png b/static/mockup/oboarding-3.png new file mode 100644 index 00000000..3c16f97e Binary files /dev/null and b/static/mockup/oboarding-3.png differ diff --git a/static/mockup/oboarding-4.png b/static/mockup/oboarding-4.png new file mode 100644 index 00000000..642a7df6 Binary files /dev/null and b/static/mockup/oboarding-4.png differ diff --git a/static/mockup/platform-select.png b/static/mockup/platform-select.png new file mode 100644 index 00000000..a03e1c29 Binary files /dev/null and b/static/mockup/platform-select.png differ diff --git a/static/mockup/play-store.png b/static/mockup/play-store.png new file mode 100644 index 00000000..d83c76b6 Binary files /dev/null and b/static/mockup/play-store.png differ diff --git a/static/mockup/restore-highlighted.png b/static/mockup/restore-highlighted.png new file mode 100644 index 00000000..c142c8a5 Binary files /dev/null and b/static/mockup/restore-highlighted.png differ diff --git a/static/mockup/restore-recovery-key-empty.png b/static/mockup/restore-recovery-key-empty.png new file mode 100644 index 00000000..044949be Binary files /dev/null and b/static/mockup/restore-recovery-key-empty.png differ diff --git a/static/mockup/restore-recovery-key.png b/static/mockup/restore-recovery-key.png new file mode 100644 index 00000000..fdcb0aa9 Binary files /dev/null and b/static/mockup/restore-recovery-key.png differ diff --git a/static/mockup/restore-select-file.png b/static/mockup/restore-select-file.png new file mode 100644 index 00000000..5fe1c179 Binary files /dev/null and b/static/mockup/restore-select-file.png differ diff --git a/static/mockup/restore.png b/static/mockup/restore.png new file mode 100644 index 00000000..700488d5 Binary files /dev/null and b/static/mockup/restore.png differ diff --git a/static/mockup/rmail-accounts.png b/static/mockup/rmail-accounts.png new file mode 100644 index 00000000..c33cfee1 Binary files /dev/null and b/static/mockup/rmail-accounts.png differ diff --git a/static/mockup/rmail-phone-input.png b/static/mockup/rmail-phone-input.png new file mode 100644 index 00000000..051cdc96 Binary files /dev/null and b/static/mockup/rmail-phone-input.png differ diff --git a/static/mockup/routing-number.png b/static/mockup/routing-number.png new file mode 100644 index 00000000..18f9f467 Binary files /dev/null and b/static/mockup/routing-number.png differ diff --git a/static/mockup/routing-numbers.png b/static/mockup/routing-numbers.png new file mode 100644 index 00000000..7182d663 Binary files /dev/null and b/static/mockup/routing-numbers.png differ diff --git a/static/mockup/telegram-accounts.png b/static/mockup/telegram-accounts.png new file mode 100644 index 00000000..a9501efa Binary files /dev/null and b/static/mockup/telegram-accounts.png differ diff --git a/static/mockup/verify-telegram-code.png b/static/mockup/verify-telegram-code.png new file mode 100644 index 00000000..c6b2f5d5 Binary files /dev/null and b/static/mockup/verify-telegram-code.png differ