Merge pull request #7 from SunriseCommunity/fix/broken-paths

Author: richardscull

astro.config.mjs

@@ -5,7 +5,7 @@ import mermaid from 'astro-mermaid';
 import starlightThemeRapide from 'starlight-theme-rapide';
 import starlightImageZoom from 'starlight-image-zoom';
 import starlightScrollToTop from 'starlight-scroll-to-top';
-
+import starlightLinksValidator from 'starlight-links-validator';
 
 // https://astro.build/config
 export default defineConfig({
@@ -54,7 +54,7 @@ export default defineConfig({
 				},
 			],
 			description: 'Documentation for the Sunrise osu! server project, including setup guides and configuration options.',
-			plugins: [starlightThemeRapide(), starlightImageZoom(), starlightScrollToTop()],
+			plugins: [starlightLinksValidator(), starlightThemeRapide(), starlightImageZoom(), starlightScrollToTop(), ],
 			customCss: [
 				'./src/styles/custom.css'
 			],

bun.lock

@@ -17,6 +17,7 @@
     "mermaid": "^11.12.2",
     "sharp": "^0.34.2",
     "starlight-image-zoom": "^0.13.2",
+    "starlight-links-validator": "0.19.2",
     "starlight-scroll-to-top": "^0.4.0",
     "starlight-theme-rapide": "^0.5.2"
   }

package.json

@@ -13,14 +13,14 @@ This section will help you set up Sunrise server on your local environment.
 This installation guide was in use before the [Solar System](https://github.com/SunriseCommunity/Solar-System) was introduced. **It is now deprecated and not recommended for production use.**
 
 
-### **Please refer to the new [Installation](../getting-started/installation) guide for the recommended way to set up the server.**
+### **Please refer to the new [Installation](/getting-started/installation) guide for the recommended way to set up the server.**
 
 You can still use this guide if you are interested in the old setup process or if you are running a development environment.
 :::
 
 We are going to set up "Production" ready environment, which means we will use Docker to run the server and other components.
 
-If you are more interested in development setup, please refer to the [Contributing](../contributing) section.
+If you are more interested in development setup, please refer to the [Contributing](/contributing) section.
 
 ## Prerequisites
 
@@ -301,4 +301,4 @@ If you encounter any issues during the setup process, please check the following
 
 Now that you have the server up and running, you can start exploring its features and capabilities.
 
-If you would like to give you admin privileges to your account, or generally want to know how to manage the server, check out the [Configuration](../getting-started/configuration) section.
+If you would like to give you admin privileges to your account, or generally want to know how to manage the server, check out the [Configuration](/getting-started/configuration) section.

src/content/docs/deprecated/installation-without-orchestrator.mdx

@@ -10,11 +10,11 @@ This section will cover some of the most common questions about Sunrise, its fea
 
 ## How do I set up the server?
 
-You can find the setup guide in the [Installation](./installation) section of the documentation. It covers everything from prerequisites to running the server.
+You can find the setup guide in the [Installation](/getting-started/installation) section of the documentation. It covers everything from prerequisites to running the server.
 
 ## How do I contribute to the project?
 
-You can find the contribution guidelines in the [Contributing](../contributing) section of the documentation.
+You can find the contribution guidelines in the [Contributing](/contributing) section of the documentation.
 
 ## How do I report a bug or request a feature?
 

src/content/docs/getting-started/faq.mdx

@@ -10,7 +10,7 @@ We are going to set up "Production" ready environment, for this we are going to
 
 Solar System is an orchestration tool that simplifies the deployment and management of Sunrise and its related components using Docker. It provides easy setup and configuration for server administrators with versioning support.
 
-If you are more interested in development setup, please refer to the [Contributing](../contributing) section.
+If you are more interested in development setup, please refer to the [Contributing](/contributing) section.
 
 :::tip
 👀 We recommend watching the **[installation video guide](https://youtu.be/ukVc4anmtIs?si=ElITsNDIXw6ijxGP)** for a step-by-step walkthrough. 
@@ -112,7 +112,7 @@ You may be prompted to run multiple scripts during setup. If you are using **Win
 :::note
 If you want Sunrise to use the Bancho API **(highly recommended)**, fill `OBSERVATORY_BANCHO_CLIENT_ID` and `OBSERVATORY_BANCHO_CLIENT_SECRET` in `.env`. 
 
-If you don't know how to get these values, follow the instructions in the [FAQ](./faq#where-can-i-get-bancho_client_id-and-bancho_client_secret) section.
+If you don't know how to get these values, follow the instructions in the [FAQ](/getting-started/faq#where-can-i-get-bancho_client_id-and-bancho_client_secret) section.
 :::
 
 ### 4. Running the Server
@@ -214,7 +214,7 @@ If you encounter any issues during the setup process, please check the following
 
 Now that you have the server up and running, you can start exploring its features and capabilities.
 
-Please follow the [Configuration](./configuration) section to learn how to manage the server.
+Please follow the [Configuration](/getting-started/configuration) section to learn how to manage the server.
 
 You will learn how to:
 - Update website branding (logo, colors, etc.)

src/content/docs/getting-started/installation.mdx

@@ -67,7 +67,7 @@ Sunrise is built with the following principles in mind:
 
 We hope this gives you a better understanding of what Sunrise is and what it aims to achieve.
 
-If you more interested in the technical details of how the server works, check out the [Contributing](../contributing) section.
+If you more interested in the technical details of how the server works, check out the [Contributing](/contributing) section.
 
 Now, let's get started with setting up the server and exploring its features!
 

src/content/docs/getting-started/what-is-sunrise.mdx

@@ -8,10 +8,10 @@ hero:
     file: ../../assets/frontpage.png
   actions:
     - text: Get Started
-      link: getting-started/installation
+      link: /getting-started/installation
       icon: right-arrow
     - text: What is Sunrise?
-      link:  getting-started/what-is-sunrise
+      link:  /getting-started/what-is-sunrise
       icon: external
       variant: minimal