Make small changes on the documentation (#357)

* Correct text in blog post * Update meta description and image * Show last update time on docs pages
klaasnicolaas · Jan 12, 2024 · 43af6ed · 43af6ed
1 parent 490478e
commit 43af6ed
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 4 deletions.
diff --git a/docs/blog/2024-01-11-fresh-new-start.md b/docs/blog/2024-01-11-fresh-new-start.md
@@ -45,7 +45,7 @@ This feature was already present in the old development branch, but never includ
 
 The firmware building process has undergone a significant rewrite, allowing the generation of firmware files tailored to various board types. These files are used in the [Getting Started](/docs/getting-started#step-2-install-firmware) section by ESP web tools.
 
-Moving forward, new firmware builds will be published on a weekly basis. This ensures that the firmware used on the website consistently incorporates the latest version of ESPHome, providing new users with up-to-date features and improvements.
+Moving forward, firmware builds will be tested on a weekly basis. This ensures that build problems with latest versions of ESPHome are identified more quickly, providing new users with up-to-date features and improvements in the future.
 
 ---
 

diff --git a/docs/docs/introduction.mdx b/docs/docs/introduction.mdx
@@ -10,7 +10,7 @@ During my internship at [Nabu Casa](https://www.nabucasa.com) in the first half
 
 ## What is this thing?
 
-Home Assistant Glow makes a (not so) smart meter without a P1 port easily readable, reading the pulse LED that is always present in most cases and it works with [ESPHome](https://esphome.io)! To neatly hide it all in your meter cupboard, a case has been designed that you can 3D print yourself.
+Home Assistant Glow makes a (not so) smart meter without a P1 port easily readable, using the pulse LED that is always present in most cases and it works with [ESPHome](https://esphome.io)! To neatly hide it all in your meter cupboard, a case has been designed that you can 3D print yourself.
 
 <p align="center">
   <img width="80%" src={require('@site/static/img/home-assistant-glow.jpg').default} />

diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts
@@ -38,6 +38,7 @@ const config: Config = {
       {
         docs: {
           sidebarPath: './sidebars.ts',
+          showLastUpdateTime: true,
           // Please change this to your repo.
           // Remove this to remove the "edit this page" links.
           editUrl:
@@ -59,7 +60,7 @@ const config: Config = {
 
   themeConfig: {
     // Replace with your project's social card
-    image: 'img/docusaurus-social-card.jpg',
+    image: 'img/home-assistant-glow.jpg',
     navbar: {
       title: 'Home Assistant Glow',
       logo: {

diff --git a/docs/src/pages/index.tsx b/docs/src/pages/index.tsx
@@ -33,7 +33,7 @@ export default function Home(): JSX.Element {
   return (
     <Layout
       title={`${siteConfig.title}`}
-      description="Description will go into a meta tag in <head />">
+      description="The Home Assistant Glow makes a (not so) smart meter without a P1 port easily readable, using the pulse LED that is always present in most cases and it works with ESPHome!">
       <HomepageHeader />
       <main>
         <HomepageFeatures />
-Original file line number
+Diff line change
@@ Expand Up @@
     The firmware building process has undergone a significant rewrite, allowing the generation of firmware files tailored to various board types. These files are used in the [Getting Started](/docs/getting-started#step-2-install-firmware) section by ESP web tools.
-    Moving forward, new firmware builds will be published on a weekly basis. This ensures that the firmware used on the website consistently incorporates the latest version of ESPHome, providing new users with up-to-date features and improvements.
+    Moving forward, firmware builds will be tested on a weekly basis. This ensures that build problems with latest versions of ESPHome are identified more quickly, providing new users with up-to-date features and improvements in the future.
     ---
@@ Expand Down @@