Review and update content

Katie Brooks · Katie Brooks · commit db042a14db38 · 2024-12-12T16:37:30.000Z
diff --git a/README.md b/README.md
@@ -13,10 +13,10 @@
 
 # Cachet Documentation
 
-[Cachet](https://cachethq.io) is a beautiful and powerful open-source status page system that allows you to better communicate downtime and
+[Cachet](https://cachethq.io) is an easy-to-use and powerful open-source status page system. Cachet allows you effectively communicate downtime and
 system outages to your customers, teams, and shareholders.
 
-This repository contains the source code for the Cachet documentation, which is built using [Mintlify](https://mintlify.com).
+This repository contains the source code for the Cachet documentation which is built using [Mintlify](https://mintlify.com).
 
 ## Running Locally
 
diff --git a/v3.x/configuration/beacon.mdx b/v3.x/configuration/beacon.mdx
@@ -5,11 +5,11 @@ icon: 'lighthouse'
 ---
 
 Cachet's "beacon" system is an optional telemetry system that allows you to send anonymous usage data to Cachet.
-This data helps us understand how Cachet is being used and how we can improve it.
+This data helps us to understand how Cachet is being used and how we can improve it.
 
 ## Configuration
 
-By default, Cachet's beacon is turned off. You can opt into it by setting the `CACHET_BEACON` environment variable to `true`.
+By default, Cachet's beacon is turned off. You can opt in by setting the `CACHET_BEACON` environment variable to `true`.
 
 ```ini .env
 CACHET_BEACON=true
diff --git a/v3.x/configuration/cachet.mdx b/v3.x/configuration/cachet.mdx
@@ -43,8 +43,7 @@ When the number of down components exceeds the specified threshold, the status p
 
 ## Automatically Refresh Page
 
-The "Automatically Refresh Page" setting allows you to enable or disable the automatic refresh of your status page. When
-enabled, the status page will automatically refresh at the specified interval.
+The "Automatically Refresh Page" setting allows you to enable or disable the automatic refresh of your status page. When enabled, the status page will automatically refresh at the specified interval.
 
 The provided number will be the number of seconds between each refresh.
 
@@ -79,5 +78,4 @@ page. When enabled, the status page will only display days with incidents. By de
 
 ### Show Dashboard Link
 
-The "Show Dashboard Link" setting allows you to enable or disable the display of the "Dashboard" link in the header of your
-status page. When enabled, the status page will display a link to the Cachet dashboard.
+The "Show Dashboard Link" setting allows you to enable or disable the display of the "Dashboard" link in the header of your status page. When enabled, the status page will display a link to the Cachet dashboard.
diff --git a/v3.x/configuration/customization.mdx b/v3.x/configuration/customization.mdx
@@ -5,7 +5,7 @@ icon: 'palette'
 ---
 
 Cachet provides the ability to customize your status page with custom HTML and CSS. To customize your status page,
-navigate to the "Manage Customization" section under Settings found in your Cachet dashboard.
+navigate to the "Manage Customization" section which is found under "Settings" in your Cachet dashboard.
 
 ## Custom Header HTML
 
@@ -30,18 +30,16 @@ your status page, you can use the following script:
 
 ## Custom Footer HTML
 
-This section allows you to add custom HTML to the footer of your status page. This is an ideal section to add custom
-scripts or styles.
+Add custom HTML to the footer of your status page to personalize scripts or styles.
 
 HTML or scripts placed in this section will be added to the end of the `<body>` of your status page.
 
 ## Custom CSS
 
-This section allows you to add custom CSS to your status page. This is an ideal section to add custom styles to your
-status page. You do not need to include `<style>` tags in this section, the CSS will be automatically wrapped in them.
+Add custom CSS to your status page to personalize the design. You do not need to include `<style>` tags as the CSS will be automatically wrapped in them.
 
 CSS placed in this section is appended to Cachet's custom styles.
 
 <Info>
-    You may make use of Cachet's CSS variables in this section. Note that these variables are not complete and are subject to change.
+    You may make use of Cachet's CSS variables but note they are not complete and are subject to change.
 </Info>
diff --git a/v3.x/configuration/theme.mdx b/v3.x/configuration/theme.mdx
@@ -5,11 +5,11 @@ icon: 'swatchbook'
 ---
 
 Cachet provides the ability to configure and theme the status page to match your brand. To customize your status page,
-navigate to the "Manage Theme" section under Settings found in your Cachet dashboard.
+navigate to the "Manage Theme" section found under "Settings" in your Cachet dashboard.
 
 ## Banner Image
 
-To override the default banner image shown at the top of a status page, navigate to the "Manage Theme" section under Settings.
+To override the default banner image shown at the top of a status page, navigate to the "Manage Theme" section under "Settings".
 
 You may upload a custom image by drag and dropping the file into the "Banner Image" field. Alternatively, you can click to select a file.
 
diff --git a/v3.x/demo.mdx b/v3.x/demo.mdx
@@ -7,7 +7,7 @@ description: "There's no better way to see what Cachet can do than to see it in
     <Card icon="circle-check" title="Cachet v3.x Demo" href="https://v3.cachethq.io">
         There's no better way to see what Cachet can do than to see it in action.
 
-        Check out our demo to see how Cachet can help you.
+        Take a look at our demo to see how Cachet can help you.
     </Card>
 
     <Card icon="users" title="Cachet v3.x Dashboard" href="https://v3.cachethq.io/dashboard">
diff --git a/v3.x/guide/components.mdx b/v3.x/guide/components.mdx
@@ -7,7 +7,7 @@ icon: 'traffic-light'
 In Cachet, a component represents any part of your system that can fail. Components are displayed on your status page
 and can be grouped together to form component groups.
 
-For example, you may have an "Ingest" component that represent your ingestion service, or a "Database" component that
+For example, you may have an "Ingest" component that represents your ingestion service, or a "Database" component that
 represents your database service.
 
 You can manage your components by navigating to the "Components" page in the dashboard.
@@ -22,7 +22,7 @@ A component has the following properties:
 
 ### Managing Components from the Dashboard
 
-Cachet also provides a simple way of updating your component statuses directly from the Dashboard homepage.
+Cachet also provides a simple way of updating your component statuses directly from the Dashboard homepage. Here you can update the status quickly by clicking the appropriate status button rather than navigating through the "Components" page. 
 
 <Frame caption="Update Component Statuses">
     <img className="block dark:hidden" src="/v3.x/images/component-dashboard-light.png" alt="Manage Components" />
@@ -49,7 +49,7 @@ component groups on your status page.
 
 ## Re-ordering Components
 
-You may reorder components via the dashboard by dragging and dropping them into the desired order. To achieve this,
+You may reorder components via the dashboard by dragging and dropping them into the desired order. To do this,
 head to the "Components" page in the dashboard, click the swap icon (up / down arrows) in the top left of the table to
 activate re-ordering mode, and then drag and drop the components into the desired order. Once you're happy with the new
 order, click the check icon to save your changes.
diff --git a/v3.x/guide/dashboard.mdx b/v3.x/guide/dashboard.mdx
@@ -5,7 +5,7 @@ icon: 'gauge'
 ---
 
 The Cachet dashboard is powered by [Filament](https://filamentphp.com), an open-source dashboard tool for Laravel.
-The dashboard is accessible at your status page's `/dashboard` URL and is where you can manage your Cachet installation,
+The dashboard is accessed via your status page's `/dashboard` URL. Here you can manage your Cachet installation,
 including managing incidents, components, and subscribers.
 
 ## User Management
diff --git a/v3.x/guide/incidents.mdx b/v3.x/guide/incidents.mdx
@@ -29,7 +29,7 @@ Incidents and updates in Cachet can have one of the following statuses:
 
 ## Incident Components
 
-Incidents don't typically occur in isolation. They often affect one or more components of the service. Cachet allows you
+Incidents don't typically occur in isolation. They often affect one or more [components](/v3.x/guide/components) of the service. Cachet allows you
 to link incidents to components to provide more context about the incident.
 
 Once you’ve created an incident, you can link it to a component by editing the incident and clicking "Attach" in the "Components"
@@ -38,7 +38,7 @@ panel on the incident page. When attaching a component, you may also select what
 ## Incident Updates
 
 Typically, incidents are ongoing events that require updates to keep users informed. Incident updates can be added to
-an incident to provide more information about the incident. Incident updates consist of:
+an incident to provide more information. Incident updates consist of:
 
 - **Message**: A detailed description of the update.
 - **Status**: The [status](#incident-statuses) of the incident after the update.
@@ -51,7 +51,7 @@ To update an incident, head to the "Incidents" panel in the dashboard and click
 
 ## Incident Templates
 
-Cachet allows you to create incident templates to help you quickly create incidents. Cachet supports creating incident
+Cachet allows you to build incident templates so you can create incidents quickly. Cachet supports creating incident
 templates with two templating languages:
 
 <CardGroup>
diff --git a/v3.x/guide/metrics.mdx b/v3.x/guide/metrics.mdx
@@ -20,7 +20,7 @@ A metric consists of:
 - **Description**: A description of the metric, e.g. `The number of users currently online`.
 - **Default View**: How to display the metric, e.g. Last hour, Today, Week, Month.
 - **Default Value**: The default value of the metric when missing points, e.g. `0`.
-- **Display Chart**: Whether to plot the metric in a chart on the status page.
+- **Display Chart**: Plot the metric in a chart on the status page, this can be enabled or disabled. 
 - **Places**: The number of decimal places to display.
 - **Metric Type**: The type of calculation to perform on the metric, e.g. sum or average.
 - **Threshold**: The threshold determines when a new point should be created or the last point updated.
diff --git a/v3.x/guide/schedules.mdx b/v3.x/guide/schedules.mdx
@@ -4,7 +4,7 @@ description: 'Learn how to manage scheduled maintenance in Cachet.'
 icon: 'clock'
 ---
 
-Not all incidents are unexpected. Sometimes, you need to perform maintenance on your services, which can cause downtime.
+Not all incidents are unexpected. Sometimes, you need to perform maintenance on your services which can cause downtime.
 Scheduled maintenance allows you to inform your users about upcoming maintenance and its impact.
 
 A scheduled maintenance event consists of:
@@ -24,13 +24,13 @@ Cachet automatically infers the status of a schedule based on the current date a
 
 ## Schedule Updates
 
-Sometimes, you may need to provide updates to a schedule. Perhaps the maintenance is taking longer than expected, or
+You may need to provide an update on scheduled maintenance, for example if the maintenance is taking longer than expected, or
 you need to provide more information.
 
 A scheduled update consists of:
 
 - **Message**: A detailed description of the update.
-- **Completed At**: The date and time when the maintenance was completed.
+- **Completed At**: The date and time that the maintenance was completed.
 
 To update an incident, head to the "Incidents" panel in the dashboard and click "Record Update" on the incident you want to update.
 
diff --git a/v3.x/guide/subscribers.mdx b/v3.x/guide/subscribers.mdx
@@ -9,4 +9,4 @@ icon: 'user-check'
     [GitHub issue](https://github.com/cachethq/core/issues/79).
 </Note>
 
-Subscribers represent people who have opted in to receive notifications about incidents and component changes.
+Subscribers represent people who have opted to receive notifications about incidents and component changes.
diff --git a/v3.x/introduction.mdx b/v3.x/introduction.mdx
@@ -18,23 +18,21 @@ description: 'Cachet is a beautiful and powerful open source status page system.
 
 ## Overview
 
-Cachet is a beautiful and powerful open source status page system used by thousands of organizations worldwide.
+Cachet is a powerful open source status page system used by thousands of organizations worldwide.
 
-Status pages often get overlooked, but they're an essential part of any organization's communication strategy.
-They help you keep your customers, teams, and stakeholders informed during downtime, maintenance, and incidents. Cachet
-aims to make this process as simple as possible, with a beautiful and easy-to-use interface.
+Status pages often get overlooked but they're an essential part of any organization's communication strategy.
+They help you to keep your customers, teams, and stakeholders informed during downtime, maintenance, and incidents. Cachet makes this process as simple as possible with its easy-to-use dashboard and customizable interface.
 
 <Frame caption="Screenshot of Cachet v3.x">
     <img className="block dark:hidden" src="/v3.x/images/screenshot-light.png" alt="Cachet in light mode" />
     <img className="hidden dark:block" src="/v3.x/images/screenshot-dark.png" alt="Cachet in dark mode" />
 </Frame>
 
-From startups to Fortune 500 companies, organizations worldwide trust Cachet to streamline their downtime communication,
-enhancing transparency with customers, teams, and stakeholders.
+From startups to Fortune 500 companies, organizations worldwide trust Cachet to streamline their downtime communication, enhancing their transparency with customers, teams, and stakeholders.
 
 ## Cachet v3.x Status
 
-Cachet v3.x is under active development. This means that not all features are currently available, and some features may be incomplete or subject to change.
+Cachet v3.x is under active development. This means that not all features are currently available and some features may be incomplete or subject to change.
 
 We're working hard to bring you the best possible experience with Cachet v3.x.
 If you encounter any issues or have any feedback, please let us know by [opening an issue on GitHub](https://github.com/cachethq/cachet/issues/new).
