diff --git a/apps/docs/advanced/achievements.mdx b/apps/docs/advanced/achievements.mdx index f02021f..6a8135f 100644 --- a/apps/docs/advanced/achievements.mdx +++ b/apps/docs/advanced/achievements.mdx @@ -1,23 +1,27 @@ --- title: "Achievement Collection" folder: "Advanced" +icon: "stars" --- Achievements are a page that every server gets which contains certain requirements which could be embedded in an servers history. - These achievements are accessable using the "Achievements" tab on the left of any server page. -Achievements are *not* collected instantly, and are collected every 12 hours when the server is online (this is not timezone dependent). +Achievements are _not_ collected instantly, and are collected every 12 hours when the server is online (this is not timezone dependent). There are currently 4 possible achievements to get, ranging from easiest to hardest. ## 1 thousand favorites achievement -After getting 1 thousand favorites on MHSF, and your server is online during the achievement collection, *you will get this achievement showing* when you got **1,000 users to favorite your server**. + +After getting 1 thousand favorites on MHSF, and your server is online during the achievement collection, _you will get this achievement showing_ when you got **1,000 users to favorite your server**. ## 1 thousand total joins achievement -After getting 1 thousand total joins on Minehut, and your server is online during the achievement collection, *you will get this achievement showing* when you got **1,000 users to join your server**. + +After getting 1 thousand total joins on Minehut, and your server is online during the achievement collection, _you will get this achievement showing_ when you got **1,000 users to join your server**. ## 100 thousand favorites achievement -After getting 100 thousand favorites on MHSF, and your server is online during the achievement collection, *you will get this achievement showing* when you got **100 thousand users to favorite your server**. + +After getting 100 thousand favorites on MHSF, and your server is online during the achievement collection, _you will get this achievement showing_ when you got **100 thousand users to favorite your server**. ## 100 thousand total joins achievement -After getting 100 thousand total joins on Minehut, and your server is online during the achievement collection, *you will get this achievement showing* when you got **100 thousand users to join your server**. \ No newline at end of file + +After getting 100 thousand total joins on Minehut, and your server is online during the achievement collection, _you will get this achievement showing_ when you got **100 thousand users to join your server**. diff --git a/apps/docs/advanced/command-bar.mdx b/apps/docs/advanced/command-bar.mdx index 038a617..3a72faf 100644 --- a/apps/docs/advanced/command-bar.mdx +++ b/apps/docs/advanced/command-bar.mdx @@ -1,9 +1,9 @@ --- title: "Using the Command-bar" folder: "Advanced" +icon: "terminal" --- - The command-bar has many mods and is a great tool for power-users to use as its built to be fast, while showing optimal information to the scenario diff --git a/apps/docs/advanced/tech-stack.mdx b/apps/docs/advanced/tech-stack.mdx index 65b109f..72b9cdd 100644 --- a/apps/docs/advanced/tech-stack.mdx +++ b/apps/docs/advanced/tech-stack.mdx @@ -1,11 +1,13 @@ --- title: "Tech-stack" folder: "Advanced" +icon: "layer-group" --- The tech stack of MHSF is relatively modern to ensure MHSF keeps up with standards set for accessibility and usability. ## Front-end + - **React** is used as a way to replicate components already used, and use the eco-system of pre-existing components - **shadcn/ui** is the UI framework used to keep the whole website consistent. - **Contentlayer** manages all the pages used for documentation @@ -13,11 +15,12 @@ The tech stack of MHSF is relatively modern to ensure MHSF keeps up with standar - **Sonner** provides the Toast used for MHSF ## Back-end + - **Inngest** runs periodic tasks - **MongoDB** is the database of choice for MHSF ## Both + - **Clerk** is used for authentication of users - **Next.js** is used to make sure API endpoints and front-end endpoints are on the same domain, along with lots of convient features - **Vercel** is hosting MHSF (along with non-tracking analytics) - diff --git a/apps/docs/changelog.mdx b/apps/docs/changelog.mdx index 3ecfce9..2ee4c45 100644 --- a/apps/docs/changelog.mdx +++ b/apps/docs/changelog.mdx @@ -1,5 +1,6 @@ --- title: "Changelog" +icon: "newspaper" --- diff --git a/apps/docs/getting-started.mdx b/apps/docs/getting-started.mdx index 5974117..2ec2445 100644 --- a/apps/docs/getting-started.mdx +++ b/apps/docs/getting-started.mdx @@ -1,5 +1,6 @@ --- title: "Getting Started" +icon: "play" --- diff --git a/apps/docs/guides/customization.mdx b/apps/docs/guides/customization.mdx index 39c450a..4e8c4b7 100644 --- a/apps/docs/guides/customization.mdx +++ b/apps/docs/guides/customization.mdx @@ -1,6 +1,7 @@ --- title: "Customization" folder: "Guides" +icon: "gear" --- Customizing your server is very easy after you have [linked your account](/docs/guides/linking). Make sure you have done that before then. diff --git a/apps/docs/guides/linking.mdx b/apps/docs/guides/linking.mdx index 223d320..435891b 100644 --- a/apps/docs/guides/linking.mdx +++ b/apps/docs/guides/linking.mdx @@ -1,9 +1,9 @@ --- title: "Linking your account" folder: "Guides" +icon: "link" --- - MHSF uses a safe & secure system to link your account that **doesn't use your Microsoft account in any way**. MHSF uses a simple system of logging into a server, and then putting a code into the website. @@ -16,35 +16,38 @@ MHSF uses a safe & secure system to link your account that **doesn't use your Mi ## Linking - -Hit your profile on the top, and go to the settings - - -If your account hasn't already been linked, you should be able to hit the Link button. - - -You can pick either one of these options: -- **CoreBoxx**, a popular box server, is also a MHSF partner who has partnered to add the plugin to allow you to link through the server. - The server should be online all day, and is recommended to use. -- **MHSFPV** was a server designed for only linking. This option is not recommended because **the server is always offline** and must be turned on manually. - - -Join the server using either `CoreBoxx.minehut.gg` or `MHSFPV.minehut.gg` - - Like said above, MHSFPV will most likely need to be turned on via the lobby. - -If using CoreBoxx, type the `/mhsf` command. - -If either server denies you saying you were already linked, and you were linked before, hit the "Force unlink" link in the "Unlink" section. -This is a known bug. - - - -Use the code from this server and input it into MHSF, and then submit. - - -You should be linked. - + + Hit your profile on the top, and go to the settings + + + If your account hasn't already been linked, you should be able to hit the + Link button. + + + You can pick either one of these options: - **CoreBoxx**, a popular box + server, is also a MHSF partner who has partnered to add the plugin to allow + you to link through the server. The server should be online all day, and is + recommended to use. - **MHSFPV** was a server designed for only linking. + This option is not recommended because **the server is always offline** and + must be turned on manually. + + + Join the server using either `CoreBoxx.minehut.gg` or `MHSFPV.minehut.gg` + + Like said above, MHSFPV will most likely need to be turned on via the + lobby. + + If using CoreBoxx, type the `/mhsf` command. + + If either server denies you saying you were already linked, and you were + linked before, hit the "Force unlink" link in the "Unlink" section. This + is a known bug. + + + + Use the code from this server and input it into MHSF, and then submit. + + You should be linked. ## Functions diff --git a/apps/docs/guides/owning-a-server.mdx b/apps/docs/guides/owning-a-server.mdx index 512325c..d3f8a8a 100644 --- a/apps/docs/guides/owning-a-server.mdx +++ b/apps/docs/guides/owning-a-server.mdx @@ -1,9 +1,10 @@ --- title: "Own a server" folder: "Guides" +icon: "server" --- -Owning a server is quite simple and allows you to [customize your server](/docs/guides/customization) and make it stand out from other servers. Before owning your server, make sure you agree to the [Rules](/docs/legal/rules). +Owning a server is quite simple and allows you to [customize your server](/docs/guides/customization) and make it stand out from other servers. Before owning your server, make sure you agree to the [ECA](Docs:legal/external-content-agreement). ## Linking diff --git a/apps/docs/guides/reporting-server.mdx b/apps/docs/guides/reporting-server.mdx index 076b18b..d0b88c8 100644 --- a/apps/docs/guides/reporting-server.mdx +++ b/apps/docs/guides/reporting-server.mdx @@ -1,6 +1,7 @@ --- title: "Reporting a server" folder: "Guides" +icon: "flag" --- If you believe a server that you've seen is under breach of the [Rules](/docs/legal/rules), you may request the server in question to be taken down. diff --git a/apps/docs/legal/rules.mdx b/apps/docs/legal/rules.mdx index 98bf3b6..bbad76f 100644 --- a/apps/docs/legal/rules.mdx +++ b/apps/docs/legal/rules.mdx @@ -1,5 +1,6 @@ --- title: "MHSF Platform Rules" +icon: "scale-balanced" --- MHSF is a platform & wrapper for the popular server host, Minehut, designed to be a friendly and useful location to find information @@ -18,7 +19,8 @@ Generally, if you use MHSF as intended—sharing useful information about your s other platforms *operated* by MHSF (for example, GitHub issues, pull requests, Discord threads, etc.) - These rules could be easily overwritten if MHSF is self-hosted by another entity. +These rules could be easily overwritten if MHSF is self-hosted by another entity. + ## Jurisdiction