docs: add more images to testing guide

myriadsocial · Nov 9, 2024 · f6a084f · f6a084f
1 parent 9c55e8f
commit f6a084f
Show file tree

Hide file tree

Showing 14 changed files with 141 additions and 19 deletions.
diff --git a/docs/image-10.png b/docs/image-10.png
diff --git a/docs/image-11.png b/docs/image-11.png
diff --git a/docs/image-12.png b/docs/image-12.png
diff --git a/docs/image-13.png b/docs/image-13.png
diff --git a/docs/image-14.png b/docs/image-14.png
diff --git a/docs/image-15.png b/docs/image-15.png
diff --git a/docs/image-16.png b/docs/image-16.png
diff --git a/docs/image-17.png b/docs/image-17.png
diff --git a/docs/image-18.png b/docs/image-18.png
diff --git a/docs/image-19.png b/docs/image-19.png
diff --git a/docs/image-20.png b/docs/image-20.png
diff --git a/docs/image-21.png b/docs/image-21.png
diff --git a/docs/milestone-3-documentation.md b/docs/milestone-3-documentation.md
@@ -34,10 +34,6 @@ This endpoint lets you connect directly to Myriad Social on the Paseo network, m
 
 ----
 
-[Rest of the documentation continues with Section 1...]
-
-----
-
 ## 1. Polkadot Setup, Connection, and User Guide
 
 We have revamped the Polkadot wallet integration process to make it more user-friendly. A step-by-step guide with interactive tooltips now assists you through every stage of connecting your Polkadot wallet.

diff --git a/docs/milestone-3-testing-guide.md b/docs/milestone-3-testing-guide.md
@@ -2,7 +2,9 @@
 
 To test the current additions in the third milestone, you need to access Myriad Social on the Paseo Network, where we are now live as a Parachain with ParaID 4005.
 
-![Myriad Social Login](./select-wallet.png)
+<div align="center">
+<img src="https://raw.githubusercontent.com/agustinustheo/apps/1b55f22c955dd9f0077ba0fac962d8da5bfa9f64/packages/apps-config/src/ui/logos/nodes/myriadPaseo.svg" width="200">
+</div>
 
 ## Prerequisites
 
@@ -12,6 +14,8 @@ If you haven't used Myriad Social before, you'll need to:
 2. Generate a new seed-phrase for your Myriad Social Account
 3. Connect to our RPC endpoint: `wss://ws-rpc.paseo.myriad.social`
 
+[![Myriad Paseo Dashboard](https://raw.githubusercontent.com/myriadsocial/myriad-web/refs/heads/main/docs/image-9.png)](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Fws-rpc.paseo.myriad.social)
+
 ## 1. Testing Polkadot Wallet Integration
 
 The new wallet integration now features an enhanced user interface with interactive tooltips to guide you through the connection process.
@@ -33,6 +37,9 @@ The new wallet integration now features an enhanced user interface with interact
 3. Click on the wallet icon and select "Connect with Polkadot Wallet"
 4. Follow the prompts in Nova Wallet to authorize the connection
 
+#### Video Tutorial: Nova Wallet Integration
+[![Nova Wallet Tutorial](https://img.youtube.com/vi/6PtEhR9-K50/0.jpg)](https://www.youtube.com/watch?v=6PtEhR9-K50)
+
 ## 2. Testing Timeline Features
 
 ### 2.1. Creating Regular Timeline
@@ -71,7 +78,7 @@ Test the new discovery features:
 
 ### 3.1. Account Sharing System
 
-![Multi-User Management](./multi-user.png)
+![Multi-User Token](./multi-user.png)
 
 1. Generate a Personal Access Token (PAT):
    - Navigate to account settings
@@ -86,25 +93,117 @@ Test the following features:
 3. Access level management
 4. Team member permissions
 
+#### Video Tutorial: Multi-User System
+
+[![Multi-User Tutorial](https://img.youtube.com/vi/-cf-RXFiCdM/0.jpg)](https://www.youtube.com/watch?v=-cf-RXFiCdM)
+
 ## 4. Testing Enhanced Transaction Features
 
 ### 4.1. Tipping System
 
+#### 4.1.1 Tipping User Posts
+
+The tipping system allows users to show appreciation for content through monetary tips. Here's how to send a tip:
+
+![alt text](image-10.png)
+
+1. Initiate the tip:
+   - Locate the "Send tip" button on any post
+   - Click the button to open the tipping interface
+
+![alt text](image-11.png)
+
+2. Configure your tip:
+   - Choose your preferred currency (e.g., MYRIAp)
+   - Enter the tip amount
+   - Review the transaction summary, including:
+     - Tip amount
+     - Estimated gas fee
+     - Total transaction cost
+   - Accept the Myriad Terms of Service for tipping
+
+![alt text](image-12.png)
+
+3. Sign the transaction:
+   - A PolkadotJS wallet window will appear
+   - Review the transaction details
+   - Enter your wallet password
+   - Click "Sign the transaction" to confirm
+
+![alt text](image-13.png)
+
+4. Confirmation:
+   - Wait for transaction processing
+   - A success message will appear when completed
+   - You can view transaction details or return to browsing
+
+Features:
+- Multiple currency support
+- Transparent fee display
+- Transaction verification
+- Immediate confirmation
+- Automatic recipient crediting
+
+> Note: Ensure you have sufficient balance in your wallet to cover both the tip amount and gas fees.
+
+#### 4.1.1 Tipping Users Directly
+
+To send tips directly from someone's profile:
+
 ![Step Send Tip](./step-send-tip.png)
-![Send Tip](./send-tip-myriar.png)
 
-The new tipping interface offers:
-1. Unified tipping window
-2. Quick access buttons on posts
-3. Transparent fee display
-4. Multiple currency support
+1. Look for the "Send Tip" button on their profile and click it.
+
+![alt text](image-14.png)
+
+2. A window will open where you can send your tip through the familiar tipping process.
 
-### 4.2. Exclusive Content
+### 4.2. Exclusive Content Creation and Access
 
-1. Create a new post
-2. Click the "Add Exclusive Content" button
-3. Set pricing in your preferred currency
-4. Verify the exclusive content display
+Creating exclusive content involves several steps:
+
+![alt text](image-15.png)
+
+1. Start a new post:
+   - Click the "What's on your mind?" text box
+   - This will open the post creation popup
+
+![alt text](image-16.png)
+
+2. Add exclusive content:
+   - Look for the "Add Exclusive Content" button below the main post editor
+   - Click to open the exclusive content section
+
+![alt text](image-17.png)
+
+3. Configure your exclusive content:
+   - Write your exclusive content (separate from the main post)
+   - Set the price in your preferred currency (e.g., MYRIAp)
+   - Note the 5% platform fee disclosure
+   - Accept the Myriad Terms of Service for exclusive content
+   - Click "Attach" to add the exclusive content to your post
+
+![alt text](image-18.png)
+![alt text](image-19.png)
+
+4. Complete the post:
+   - Add your main post content (visible to all users)
+   - Select a timeline for posting (can be regular or exclusive timeline)
+   - Verify your post visibility settings
+   - Click "Create Post" to publish
+
+![alt text](image-20.png)
+
+
+5. Accessing exclusive content (as a viewer):
+   - Locate a post with exclusive content
+   - Click the "Reveal Exclusive Content" button
+   - Pay the required amount to access the content
+   - View the exclusive content within the post
+
+![alt text](image-21.png)
+
+> Note: The main post content and exclusive content are separate - the main post is visible to everyone, while the exclusive content is only accessible to users who pay for access.
 
 ## 5. Testing Self-Hosting Capabilities
 
@@ -138,7 +237,34 @@ sudo journalctl -u myriad-social.service
 
 # Automated Tests
 
-For automated testing of the new features, refer to our test environment setup:
+There are two ways to run automated tests for the new features:
+
+## Option 1: Build Using Dockerfile
+
+You can build and run the test environment using our provided Dockerfile:
+
+1. Clone the repository: 
+   ```bash
+   git clone https://github.com/myriadsocial/myriad-infrastructure.git
+   ```
+2. Navigate to the directory:
+   ```bash
+   cd myriad-infrastructure/linux
+   ```
+3. Build the Docker image:
+   ```bash
+   docker build -t myriad-test .
+   ```
+4. Run the container:
+   ```bash
+   docker run -it --name myriad-test-container myriad-test
+   ```
+
+The Dockerfile is available at: https://github.com/myriadsocial/myriad-infrastructure/blob/main/linux/Dockerfile
+
+## Option 2: Use the Pre-built Container
+
+Alternatively, you can use our pre-built test container:
 
 ```bash
 docker run -it --name marauder-container \
@@ -147,4 +273,4 @@ docker run -it --name marauder-container \
 agustinustheoo/marauder-test:latest
 ```
 
-All features connect directly to the blockchain on the Paseo Network. For detailed API testing guidelines, refer to the Myriad Parachain repository.
+Note: All features connect directly to the blockchain on the Paseo Network. For detailed API testing guidelines, refer to the Myriad Parachain repository.