A few updates to the docs section

DEFRA · Jan 20, 2025 · f774e96 · f774e96
1 parent 79c6f60
commit f774e96
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 8 deletions.
diff --git a/src/server/documentation/helpers/docs-breadcrumbs.js b/src/server/documentation/helpers/docs-breadcrumbs.js
@@ -3,7 +3,7 @@ import startCase from 'lodash/startCase.js'
 function docsBreadcrumbs(docsPath) {
   const breadcrumbs = [
     {
-      text: 'Documentation',
+      text: 'CDP',
       href: '/documentation'
     }
   ]

diff --git a/src/server/documentation/helpers/docs-breadcrumbs.test.js b/src/server/documentation/helpers/docs-breadcrumbs.test.js
@@ -4,15 +4,15 @@ describe('#docsBreadcrumbs', () => {
   test('Should return expected documentation breadcrumbs for a single file path', () => {
     const result = docsBreadcrumbs('introduction.md')
     expect(result).toEqual([
-      { text: 'Documentation', href: '/documentation' },
+      { text: 'CDP', href: '/documentation' },
       { text: 'Introduction' }
     ])
   })
 
   test('Should return expected documentation for a nested file path', () => {
     const result = docsBreadcrumbs('guides/getting-started.md')
     expect(result).toEqual([
-      { text: 'Documentation', href: '/documentation' },
+      { text: 'CDP', href: '/documentation' },
       { text: 'Guides', href: '/documentation/guides/README.md' },
       { text: 'Getting Started' }
     ])
@@ -21,15 +21,15 @@ describe('#docsBreadcrumbs', () => {
   test('Should handle README.md files correctly', () => {
     const result = docsBreadcrumbs('guides/README.md')
     expect(result).toEqual([
-      { text: 'Documentation', href: '/documentation' },
+      { text: 'CDP', href: '/documentation' },
       { text: 'Guides' }
     ])
   })
 
   test('Should handle paths with multiple segments', () => {
     const result = docsBreadcrumbs('guides/advanced/topics.md')
     expect(result).toEqual([
-      { text: 'Documentation', href: '/documentation' },
+      { text: 'CDP', href: '/documentation' },
       { text: 'Guides', href: '/documentation/guides/README.md' },
       { text: 'Advanced', href: '/documentation/guides/advanced/README.md' },
       { text: 'Topics' }

diff --git a/src/server/documentation/helpers/documentation-structure.js b/src/server/documentation/helpers/documentation-structure.js
@@ -169,7 +169,7 @@ async function documentationStructure(request, bucket) {
 
   return [
     {
-      text: 'Documentation',
+      text: 'CDP',
       href: path.join(docsRoute, 'README.md'),
       level: 0
     },

diff --git a/src/server/documentation/helpers/documentation-structure.test.js b/src/server/documentation/helpers/documentation-structure.test.js
@@ -45,7 +45,7 @@ describe('#directoryStructure', () => {
     const result = await documentationStructure(mockRequest, mockBucket)
 
     expect(result).toEqual([
-      { text: 'Documentation', href: '/documentation/README.md', level: 0 },
+      { text: 'CDP', href: '/documentation/README.md', level: 0 },
       { text: 'Guides', href: '/documentation/guides/README.md', level: 1 },
       {
         text: 'Getting Started',
@@ -106,7 +106,7 @@ describe('#directoryStructure', () => {
       {
         href: '/documentation/README.md',
         level: 0,
-        text: 'Documentation'
+        text: 'CDP'
       },
       {
         href: '/documentation/guides/README.md',

diff --git a/src/server/documentation/views/documentation.njk b/src/server/documentation/views/documentation.njk
@@ -3,5 +3,16 @@
 {% from "documentation/macro.njk" import appDocumentation %}
 
 {% block content %}
+  {{ appPageHeading({
+    text: "Documentation"
+  }) }}
+
+  <p class="govuk-!-margin-bottom-2">
+    All things Core Delivery Platform, onboarding, test suites, services, and more.
+  </p>
+
+  <hr class="app-section-break app-section-break--slim">
+
   {{ appDocumentation({ nav: nav, content: content, toc: toc }) }}
+
 {% endblock %}