Adding new code snippet component

docs/Gemfile.lock

@@ -95,9 +95,10 @@ GEM
       rbs (>= 3, < 4)
       sorbet-runtime (>= 0.5.10782)
     safe_yaml (1.0.5)
-    sass-embedded (1.69.5-arm64-darwin)
+    sass-embedded (1.69.5)
       google-protobuf (~> 3.23)
-    sass-embedded (1.69.5-x86_64-linux-gnu)
+      rake (>= 13.0.0)
+    sass-embedded (1.69.5-arm64-darwin)
       google-protobuf (~> 3.23)
     sorbet-runtime (0.5.11466)
     strscan (3.1.0)

docs/_includes/components/code-snippet.html

@@ -0,0 +1,6 @@
+<div class="nhsnotify-code-snippet">
+  <span class="nhsuk-u-visually-hidden">Code snippet:</span>
+  <code>
+    {{ include.text | markdownify }}
+  </code>
+</div>

docs/_includes/components/phase-banner.html

@@ -0,0 +1,14 @@
+<div class="nhsuk-phase-banner" id="{{include.phase_id}}">
+  <div class="nhsuk-width-container">
+    <p class="nhsuk-phase-banner__content">
+      <strong class="nhsuk-tag">{{include.phase_tag}}</strong>
+      <span class="nhsuk-phase-banner__text">{{include.phase_text}}</span>
+    </p>
+  </div>
+</div>
+<script>
+  console.log("{{include.auto_hide}}")
+  if ("{{include.auto_hide}}" == 'true' && (window.location.hostname.startsWith('notify.nhs.uk') || window.location.hostname.startsWith('127.0.0.2'))) {
+    document.getElementById("{{ include.phase_id }}").style.visibility = 'hidden';
+  }
+</script>

docs/_layouts/no-nav-page.html

@@ -0,0 +1,36 @@
+---
+layout: default
+---
+
+{% assign current_dir = page.dir %}
+{% assign paths = page.dir | split: "/" %}
+{% assign parent_dir = paths[1] %}
+
+{%-
+assign nav_pages = site.pages
+| where_exp: "item", "item.dir contains parent_dir"
+-%}
+
+{% assign first_level_dir = parent_dir | prepend: '/' | append: '/' %}
+{%-
+assign first_level = nav_pages
+| where_exp: "item", "item.dir == first_level_dir"
+| group_by: "section"
+| sort: 'name', 'last'
+-%}
+
+<div class="nhsuk-width-container">
+  <main class="nhsuk-main-wrapper" id="maincontent" role="main">
+    <div class="nhsuk-grid-row">
+      <div class="nhsuk-grid-column-full">
+        <div class="nhsnotify-pane__main-content nhsuk-grid-column-three-quarters">
+          {% if page.section != undefined %}
+          <heading class="nhsuk-heading-s" style="margin-bottom: 0; color: #4c6272">{{ page.section }}</heading>
+          {% endif %}
+          <h1>{{ page.title }}</h1>
+          {{ content }}
+        </div>
+      </div>
+    </div>
+  </main>
+</div>

docs/_layouts/page.html

@@ -3,20 +3,20 @@
 ---
 
 {% assign current_dir = page.dir %}
-{% assign paths = page.dir | split: "/"  %}
+{% assign paths = page.dir | split: "/" %}
 {% assign parent_dir = paths[1] %}
 
 {%-
-  assign nav_pages = site.pages
-    | where_exp: "item", "item.dir contains parent_dir"
+assign nav_pages = site.pages
+| where_exp: "item", "item.dir contains parent_dir"
 -%}
 
 {% assign first_level_dir = parent_dir | prepend: '/' | append: '/' %}
 {%-
-  assign first_level = nav_pages
-    | where_exp: "item", "item.dir == first_level_dir"
-    | group_by: "section"
-    | sort: 'name', 'last'
+assign first_level = nav_pages
+| where_exp: "item", "item.dir == first_level_dir"
+| group_by: "section"
+| sort: 'name', 'last'
 -%}
 <div class="nhsuk-width-container">
   <main class="nhsuk-main-wrapper" id="maincontent" role="main">
@@ -26,21 +26,21 @@
           <div class="nhsnotify-pane__side-bar nhsuk-grid-column-one-quarter">
             <nav class="nhsnotify-side-nav">
               <ul class="nhsuk-list nhsnotify-side-nav__list">
-                {% for section in first_level  %}
+                {% for section in first_level %}
                 {% if section.name != "" %}
-                  <p class="nhsuk-u-font-weight-bold nhsnotify-side-nav__list-section">{{ section.name }}</p>
+                <p class="nhsuk-u-font-weight-bold nhsnotify-side-nav__list-section">{{ section.name }}</p>
                 {% endif %}
-                  {% assign sorted = section.items | sort: 'nav_order' %}
-                  {% for post in sorted %}
-                    <li class="
+                {% assign sorted = section.items | sort: 'nav_order' %}
+                {% for post in sorted %}
+                <li class="
                       nhsnotify-side-nav__item
                       {% if post.url == page.url %}
                         nhsnotify-side-nav__item--current
                       {% endif %}
                     ">
-                      <a class="nhsnotify-side-nav__link" href="{{ site.baseurl | append: post.url }}">{{ post.title }}</a>
-                    </li>
-                  {% endfor %}
+                  <a class="nhsnotify-side-nav__link" href="{{ site.baseurl | append: post.url }}">{{ post.title }}</a>
+                </li>
+                {% endfor %}
                 {% endfor %}
               </ul>
 

docs/_sass/_nhsnotify.scss

@@ -2,7 +2,7 @@
   width: unset;
   background-color: unset;
   border-bottom: 0;
-  margin:unset;
+  margin: unset;
 }
 
 .nhsnotify-banner--blue {
@@ -68,13 +68,54 @@
 }
 
 .nhsuk-header__navigation-list {
-  justify-content: flex-start;
+  justify-content: flex-centre;
 }
 
 .nhsuk-header__navigation-link {
-  text-decoration: none;
+  text-decoration: underline;
 
   &:hover {
-    text-decoration: underline;
+    text-decoration: none;
   }
 }
+
+.nhsuk-phase-banner {
+  padding-top: 10px;
+  padding-bottom: 10px;
+  background-color: #fff;
+}
+
+.nhsuk-phase-banner__content {
+  font-size: 1rem;
+  line-height: 1.25;
+  margin-bottom: 0px;
+}
+
+.nhsuk-tag {
+  outline: 2px solid transparent;
+  outline-offset: -2px;
+  color: #fff;
+  background-color: #005eb8;
+  letter-spacing: 1px;
+  text-decoration: none;
+  text-transform: uppercase;
+  font-weight: 700;
+}
+
+.nhsuk-phase-banner__text {
+  font-size: 1rem;
+  line-height: 1.25;
+  padding-left: 0.5em;
+}
+
+.nhsnotify-code-snippet {
+  background-color: $color_nhsuk-white;
+  border: 1px solid $nhsuk-border-color;
+  padding: 24px;
+  margin: 12px 0 48px 0;
+
+    :last-child{
+      margin-bottom: 0;
+      padding-bottom: 0;
+    }
+}

docs/pages/get-started/get-started.md

@@ -2,7 +2,7 @@
 # Feel free to add content and custom Front Matter to this file.
 # To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
 
-layout: page
+layout: no-nav-page
 title: Get started
 nav_order: 6
 has_children: true

docs/pages/support/support.md

@@ -2,7 +2,7 @@
 # Feel free to add content and custom Front Matter to this file.
 # To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
 
-layout: page
+layout: no-nav-page
 title: Support
 nav_order: 5
 has_children: true

docs/pages/using-nhs-notify/delivery-times.md

@@ -12,6 +12,13 @@ section: Sending a message
 
 It can take different amounts of time for messages to be delivered depending on the message channel.
 
+Find out about delivery times for:
+
+- [NHS App messages](#nhs-app-messages)<!-- markdownlint-disable-line -->
+- [emails](#emails)
+- [text messages](#text-messages-sms)
+- [letters](#letters)
+
 ## NHS App messages
 
 NHS Notify can send NHS App messages to recipients with the NHS App at any time.
@@ -42,7 +49,7 @@ NHS Notify will only send text messages from 8am to 6pm on weekdays.
 
 ## Letters
 
-Once your letter has been sent, it can take up to 6 days for it to be processed by our suppliers before it's dispatched.
+Once you've [provided us with recipients' NHS numbers]({% link pages/using-nhs-notify/tell-us-who-you-want-to-message.md %}), it can take up to 2 working days for our suppliers to dispatch your letter.
 
 First class letters are delivered 1 to 2 business days after they’re dispatched.
 

docs/pages/using-nhs-notify/mesh.md

@@ -18,4 +18,6 @@ You should only use MESH to send messages if your organisation or service:
 - only needs to send batches of messages to specific groups of recipients
 - does not need advanced features offered by NHS Notify API
 
+[Read our MESH documentation (opens in a new tab)](https://digital.nhs.uk/developer/api-catalogue/nhs-notify-mesh).
+
 Check if MESH is right for you by contacting our engagement team at <[email protected]>.

docs/pages/using-nhs-notify/message-status.md

@@ -53,7 +53,6 @@ Messages and channels that have not reached a recipient will have a 'failed' sta
 | The provider could not deliver the message.                                      |
 | There was an unexpected error while sending the letter to our printing provider. |
 | PDS - patient record invalidated.                                                |
-| PDS response date of birth does not match given date of birth.                   |
 | PDS - patient is formally dead.                                                  |
 | PDS - patient is informally dead.                                                |
 | PDS - patient has an exit code.                                                  |

docs/pages/using-nhs-notify/personalisation.md

@@ -15,69 +15,52 @@ You can send personalised messages using a single template.
 To personalise a message, use double brackets to add a placeholder to your content. For example:
 
 {% include components/inset-text.html
-    text='<code>Hello ((firstName)), your NHS Number is ((nhsNumber))'
+    text='Hello ((firstName)), your NHS Number is ((nhsNumber))'
 %}
 
-### Personal Demographics Service (PDS) personalisation fields
+## Personal Demographics Service (PDS) personalisation fields
 
-NHS Notify uses the [Personal Demographics Service (PDS)](https://digital.nhs.uk/services/personal-demographics-service) to find and populate certain personalisation fields. You only need to [provide us with recipients' NHS numbers]({% link pages/using-nhs-notify/tell-us-who-you-want-to-message.md %}).
+NHS Notify uses the [Personal Demographics Service (PDS)](https://digital.nhs.uk/services/personal-demographics-service) to find and populate certain personalisation fields for each recipient. This happens automatically when you [tell us who you want to message]({% link pages/using-nhs-notify/tell-us-who-you-want-to-message.md %}) using recipients' NHS numbers.
 
-The personalisation fields available in PDS are:
+You can use the following PDS personalisation fields in your templates:
 
 - fullName
 - firstName
 - middleNames
 - lastName
 - namePrefix
 - nameSuffix
-- address_line_1
-- address_line_2
-- address_line_3
-- address_line_4
-- address_line_5
-- address_line_6
-- address_line_7
 - nhsNumber
 - date
-- clientRef
-- recipientContactValue
-- template
 
-The placeholders in your content need to match the PDS personalisation fields.
+Any placeholders in your content need to match the PDS personalisation fields.
 
 ## Providing your own personalisation data
 
 You can provide your own personalisation data.
 
 Do not send us personalisation data that's already available in PDS. We'll use the PDS data over your own data in this case.
 
-### If you're using the API
+### If you're using NHS Notify API
 
 Include a personalisation block in your API request.
 
 For example, if you wanted to include 'practice' as a personalisation field, the personalisation block would be:
 
-{% include components/inset-text.html
-    text='{
-
-    "practice": "PRACTICE_NAME",
-
-}'
+{% include components/code-snippet.html
+text='"practice": "PRACTICE_NAME"'
 %}
 
 Read the [API documentation](https://digital.nhs.uk/developer/api-catalogue/nhs-notify#post-/v1/message-batches) to find out where to put this in your request.
 
-### If you're using the Message Exchange for Social Care and Health (MESH)
+### If you're using NHS Notify MESH
 
 Include the personalisation fields as columns in your CSV file.
 
-The column names should start with 'personalisation_', followed by the same wording as the placeholders in your template.
+The column names should start with 'personalisation\_', followed by the same wording as the placeholders in your template.
 
 For example, if you wanted to include 'practice' as a personalisation field, the column name would be:
 
 {% include components/inset-text.html
-    text='nhsNumber,requestItemRefId,dateOfBirth,personalisation_practice'
+    text='nhsNumber,requestItemRefId,personalisation_practice'
 %}
-
-*[PDS]: Personal Demographics Service
-*[MESH]: Message Exchange for Social Care and Health

docs/pages/using-nhs-notify/tell-us-who-you-want-to-message.md

@@ -31,3 +31,8 @@ The onboarding team will give you an example CSV file on request.
 
 Use the format shown in the
 <a href="https://digital.nhs.uk/developer/api-catalogue/nhs-notify" target="_blank">API documentation (opens in a new tab)</a>.
+
+## Providing your own recipient contact details
+
+If you need to use contact details that are not from PDS, you must make a formal request to NHS Notify.
+Overriding contact details is only granted to specific use cases that provide compelling data to our onboarding team. NHS Notify will consult with relevant NHS England legal and clinical teams for approval.