XS ◾ Improved readability and syntax on "include-links-in-emails" rule (

#9925)

* Improved readability and syntax on "include-links-in-emails" rule

* Auto-fix Markdown files

* Update rule.md

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

rules/include-links-in-emails/rule.md

@@ -10,6 +10,8 @@ authors:
     url: https://ssw.com.au/people/cameron-shaw
   - title: Ulysses Maclaren
     url: https://ssw.com.au/people/ulysses-maclaren
+  - title: Tiago Araujo
+    url: https://ssw.com.au/people/tiago-araujo
 related:
   - add-context-reasoning-to-emails
   - dones-do-you-include-useful-details-in-your-done-email
@@ -23,12 +25,12 @@ guid: ed0fa76a-418b-4b59-9e3b-2544c08b910e
 
 Always include the relevant URL to your emails, like when you want to request or just made a change to a webpage or document. This way people can easily check the details of the tasks. This is especially important for ["Done" emails](/reply-done-and-delete-the-email).
 
-If you are using a task tracking system like **Azure DevOps**, **GitHub**, or Jira, also include the link to the PBI/Issue/task.
+If you are using a task tracking system like **Azure DevOps**, **GitHub**, or Jira, also include the link to the PBI/Issue/task/PR for extra information.
 
 <!--endintro-->
 
 ::: info
-**Tip:** It is [important to give context and reasoning](/do-you-add-context-reasoning-to-your-emails) to your emails too.
+**Tip:** It's [important to give context and reasoning](/do-you-add-context-reasoning-to-your-emails) to your emails.
 :::
 
 ::: greybox
@@ -47,21 +49,23 @@ Figure: Good example - Easy to check what was done
 :::
 
 ::: greybox
-Done - northwind&#46;com/about-us/ as requested on ssw2&#46;visualstudio&#46;com/Northwind/\_workitems/edit/00001
+Done - northwind&#46;com/about-us/
+
+As requested on ssw2&#46;visualstudio&#46;com/Northwind/\_workitems/edit/00001
 :::
 ::: good
 Figure: Good example - Easy to check what was done + includes the context of the task within the Sprint
 :::
 
-### Ensure changes are live
+## Ensure changes are live
 
 Before declaring a task 'done' with a link, ensure that your changes are live and accessible for verification.
 
 ::: info
 **Note:** It is the PR author's responsibility to [avoid merge debt](/merge-debt) by getting the PR reviewed ASAP.
 :::
 
-#### Scenario: PR waiting for approval
+### Scenario: PR waiting for approval
 
 ::: greybox
 Done - ssw&#46;com&#46;au/rules/dones-is-your-inbox-a-task-list-only
@@ -80,14 +84,15 @@ Figure: Bad example - Using the PR link instead of the final page link
 
 ::: greybox
 (PR waiting for approval - github&#46;com/SSWConsulting/SSW.Rules.Content/pull/0001)  
+
 Done - Changes will be on ssw&#46;com&#46;au/rules/dones-is-your-inbox-a-task-list-only
 
 :::
 ::: ok
 Figure: OK example - Changes are not live yet, but people are aware and have the links
 :::
 
-#### Scenario: PR is approved and merged
+### Scenario: PR is approved and merged
 
 ::: greybox
 Done - ssw&#46;com&#46;au/rules/dones-is-your-inbox-a-task-list-only
@@ -96,22 +101,23 @@ Done - ssw&#46;com&#46;au/rules/dones-is-your-inbox-a-task-list-only
 Figure: Good example - Final link is included and changes are live to be checked
 :::
 
-### Ensure others have permissions
+## Ensure others have permissions
 
 It is a common problem where someone CC'd will not have permissions to see a file and the sender knows this. You should still add the link but inform the recipient.
 
-#### Scenario: Recipient doesn't have permissions
+### Scenario: Recipient doesn't have permissions
 
 ::: greybox
-Done - onedrive.live.com/file-name.xls
+Done - onedrive&#46;live.com/file-name.xls
 :::
 ::: bad
 Figure: Bad example - Link is included but recipient won't be able to open it, potentially generating more emails
 :::
 
 ::: greybox
 (link for reference - you don't have permissions)  
-Done - onedrive.live.com/file-name.xls
+
+Done - onedrive&#46;live.com/file-name.xls
 :::
 ::: good
 Figure: Good example - Link is included and people are aware of permission issues