Update documentation (#104)

* Update documentation * Reduce size to meet requirement * Remove step 2 in intro.php * Update string copy
wikimedia · Jan 25, 2024 · 5d18a16 · 5d18a16
1 parent 8d13564
commit 5d18a16
Show file tree

Hide file tree

Showing 7 changed files with 5 additions and 11 deletions.
diff --git a/assets/screenshot-1.png b/assets/screenshot-1.png
diff --git a/images/Step-1-detailed.png b/images/Step-1-detailed.png
diff --git a/images/Step-2-detailed.png b/images/Step-2-detailed.png
diff --git a/images/Step-3-detailed.png b/images/Step-3-detailed.png
diff --git a/images/Step-4-detailed.png b/images/Step-4-detailed.png
diff --git a/intro.php b/intro.php
@@ -67,14 +67,12 @@ function wikipediapreview_intro_submenu_page_callback() {
 	$img_illustration = wikipediapreview_image( 'illustration01.png', 'illustration' );
 	$p1               = __( 'Wikipedia Preview lets you show a popup card with a short summary from Wikipedia when a reader clicks or hovers over a link.', 'wikipedia-preview' );
 	$p2               = __( 'Wikipedia Preview is easy to set up and use. Simply follow these steps:', 'wikipedia-preview' );
-	$step1_text       = __( 'Highlight the text you want to link to a Wikipedia article.', 'wikipedia-preview' );
+	$step1_text       = __( 'Highlight the text and select ‘W’- Wikipedia Preview icon from the menu', 'wikipedia-preview' );
 	$step1_img        = wikipediapreview_image( 'Step-1-detailed.png', 'step' );
-	$step2_text       = __( 'Select ‘Wikipedia Preview’ from the menu.', 'wikipedia-preview' );
+	$step2_text       = __( 'You will see a list of suggested articles. Select the one you want to link to.', 'wikipedia-preview' );
 	$step2_img        = wikipediapreview_image( 'Step-2-detailed.png', 'step' );
-	$step3_text       = __( 'You will see a list of suggested articles. Select the one you want to link to.', 'wikipedia-preview' );
+	$step3_text       = __( 'Wikipedia Preview will automatically turn the link into a preview of the relevant Wikipedia article. You can easily edit or remove this.', 'wikipedia-preview' );
 	$step3_img        = wikipediapreview_image( 'Step-3-detailed.png', 'step' );
-	$step4_text       = __( 'Wikipedia Preview will automatically turn the link into a preview of the relevant Wikipedia article. You can easily edit or remove this.', 'wikipedia-preview' );
-	$step4_img        = wikipediapreview_image( 'Step-4-detailed.png', 'step' );
 	$html             = <<<HTML
 		<div class="wrap wikipediapreview-intro">
 			{$img_wordmark}
@@ -95,10 +93,6 @@ function wikipediapreview_intro_submenu_page_callback() {
 					<div>{$step3_text}</div>
 					{$step3_img}
 				</li>
-				<li>
-					<div>{$step4_text}</div>
-					{$step4_img}
-				</li>
 			</ol>
 		</div>
 	HTML;

diff --git a/readme.txt b/readme.txt
@@ -49,7 +49,7 @@ https://youtu.be/_m6YzR0j8Fs
 **Option 2 - How to add Wikipedia Preview links using the Gutenberg/ Block Editor:**
 
 1. Highlight the text you want to link to a Wikipedia article.
-2. Select ‘Wikipedia Preview’ from the menu.
+2. Select ‘W’ - Wikipedia Preview icon from the menu.
 3. You will see a list of suggested articles. Select the one you want to link to.
 4. Wikipedia Preview will automatically turn the link into a preview of the relevant Wikipedia article. You can easily edit or remove this.
 
@@ -90,7 +90,7 @@ It’s easy to add Wikipedia Preview links to your site. It takes only a few sec
 **Option 2 - How to add Wikipedia Preview links using the Gutenberg/ Block Editor:**
 
 1. Highlight the text you want to link to a Wikipedia article.
-2. Select ‘Wikipedia Preview’ from the menu.
+2. Select ‘W’ - Wikipedia Preview icon from the menu.
 3. You will see a list of suggested articles. Select the one you want to link to.
 4. Wikipedia Preview will automatically turn the link into a preview of the relevant Wikipedia article. You can easily edit or remove this.