Merge pull request #762 from FlowFuse/zj-seo-2-sweep

docs: Improve SEO for the website
FlowFuse · Apr 11, 2024 · b7b20a3 · b7b20a3
2 parents 4d691e5 + 083c699
commit b7b20a3
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 5 deletions.
diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js
@@ -60,7 +60,7 @@ export default ({ mode }) => {
       ])
     },
     themeConfig: {
-      logo: '/logo.png',
+      logo: { src: '/logo.png', alt: 'Node-RED Dashboard 2.0 Logo' },
       nav: [
         { text: 'Docs', link: '/getting-started.html' },
         { text: 'Widgets', link: '/nodes/widgets.html' },

diff --git a/docs/about.md b/docs/about.md
@@ -1,5 +1,5 @@
 ---
-description: "Discover the features and benefits of Node-RED Dashboard 2.0, designed to streamline and enhance your Node-RED experience."
+description: "Learn about Dashboard 2.0 technology choices"
 ---
 
 # About Node-RED Dashboard 2.0

diff --git a/docs/components/FlowFuseAdvert.vue b/docs/components/FlowFuseAdvert.vue
@@ -13,7 +13,7 @@
             <a href="https://flowfuse.com/product/why-flowfuse/">Learn More</a>
         </div>
         <div>
-            <img src="../assets/images/screenshot-flowfuse-applications.png">
+            <img src="../assets/images/screenshot-flowfuse-applications.png" alt="Image of the FlowFuse Platform">
         </div>
     </div>
 </template>

diff --git a/docs/components/RecommendedReading.vue b/docs/components/RecommendedReading.vue
@@ -1,7 +1,7 @@
 <template>
     <div class="recommended-reading">
         <a v-for="a in articles" :key="a.title" :href="a.url">
-            <img :src="a.image">
+            <img :src="a.image" :alt="a.title">
         </a>
     </div>
 </template>

diff --git a/docs/index.md b/docs/index.md
@@ -7,7 +7,7 @@ hero:
   tagline: An easy to use collection of nodes for Node-RED that allows you to create data-driven dashboards & data visualisations.
   image:
     src: /logo.png
-    alt: VitePress
+    alt: Node-RED Dashboard 2.0
   actions:
     - theme: brand
       text: Getting Started

diff --git a/docs/layouts/index.md b/docs/layouts/index.md
@@ -1,3 +1,7 @@
+---
+description: Understand how the Node-RED Dashboard layouts can be configured for your applications.
+---
+
 # Layouts
 
 Layouts are a configuration available on a page-by-page basis. They control how all of the [Groups](../nodes/config/ui-group) of widgets are laid out on a given [Page](../nodes/config/ui-page):

diff --git a/docs/nodes/widgets/ui-button.md b/docs/nodes/widgets/ui-button.md
@@ -1,4 +1,5 @@
 ---
+description: "Buttons create interactive UI's and can trigger flows in Node-RED"
 props:
     Group: Defines which group of the UI Dashboard this widget will render in.
     Size: Controls the width of the button with respect to the parent group. Maximum value is the width of the group.