docs(browser): Rearrange nav items to own sections

minekube · Apr 17, 2024 · 5296d40 · 5296d40
1 parent cdb97e5
commit 5296d40
Show file tree

Hide file tree

Showing 2 changed files with 79 additions and 27 deletions.
diff --git a/.web/docs/.vitepress/config.ts b/.web/docs/.vitepress/config.ts
@@ -225,7 +225,14 @@ export default defineConfig({
                             ]
                         },
                         {
-                            text: 'Launch Guides', link: '/browser/launch/', items: [
+                            text: 'FAQ', link: '/browser/faq/', items: []
+                        },
+                    ]
+                },
+                {
+                    text: 'Guides', items: [
+                        {
+                            text: 'Launch Guide', link: '/browser/launch/', items: [
                                 {text: 'Launch Your Server', link: '/browser/launch/server'},
                                 {text: 'Launch Your Game', link: '/browser/launch/game'},
                             ]
@@ -237,18 +244,16 @@ export default defineConfig({
                                 {text: 'Event Management', link: '/browser/engage/events'},
                             ]
                         },
-                        {
-                            text: 'API', link: '/browser/api/', items: [
-                                {text: 'Authentication', link: '/browser/api/auth'},
-                                {text: 'Versioning', link: '/browser/api/versions'},
-                                {text: 'Endpoints', link: '/browser/api/endpoints'},
-                                {text: 'Rate Limits', link: '/browser/api/ratelimits'},
-                                {text: 'SDK and Resources', link: '/browser/api/developers'},
-                            ]
-                        },
-                        {
-                            text: 'FAQ', link: '/browser/faq/', items: []
-                        },
+                    ]
+                },
+                {
+                    text: 'API', items: [
+                        {text: 'Overview', link: '/browser/api/'},
+                        {text: 'Authentication', link: '/browser/api/auth'},
+                        {text: 'Versioning', link: '/browser/api/versions'},
+                        {text: 'Endpoints', link: '/browser/api/endpoints'},
+                        {text: 'Rate Limits', link: '/browser/api/ratelimits'},
+                        {text: 'SDK and Resources', link: '/browser/api/developers'},
                     ]
                 },
                 services,
@@ -327,4 +332,4 @@ export default defineConfig({
             ],
         }
     }
-})
+})
diff --git a/.web/docs/browser/index.md b/.web/docs/browser/index.md
@@ -1,22 +1,69 @@
-# Minekube Browser Documentation <VPBadge>POC</VPBadge>
+# Minekube Browser - API Documentation
 
-::: warning
-The Minekube Browser is currently in its developmental phase. We invite you to join our [Discord](https://minekube.com/discord) community and contribute by sharing your valuable feedback!
-:::
+Welcome to the Minekube Browser API documentation. This guide provides all the necessary details to integrate with our API, focusing on server listings initially, with plans to expand to games, plugins, and mods.
 
-## Introduction
+## Table of Contents
+**Table of Contents**
 
-Whether you're a player seeking adventure, a developer crafting game worlds, or a hosting provider scaling your services, you've arrived at the starting point of endless possibilities.
+- [Authentication](#authentication)
+- [Versioning](#versioning)
+- [Endpoints](#endpoints)
+- [Rate Limits](#rate-limits)
+- [SDK and Resources](#sdk-and-resources)
+[[TOC]]
 
-The Minekube Browser is more than a server list; it's a comprehensive marketplace for Minecraft games, a launchpad for server experiences, and a hub for community-driven development. It represents a paradigm shift in Minecraft server discovery, offering tools and platforms for users to build, list, and launch Minecraft games, all underpinned by Minekube's robust distributed infrastructure services like Minekube Games for server management and Minekube Connect for simplified connectivity.
+## Authentication
 
-Our documentation is designed to be accessible and informative for a public audience, players, developers and providers, focusing on the practicalities and benefits of our platform and delving into the integration details for power users. As we walk you through the Minekube Browser, you'll understand how it caters to the needs of various stakeholders in the Minecraft ecosystem.
+Secure access to the API is controlled through API keys and other authentication mechanisms. Here, you'll find how to obtain and manage your API keys, including:
 
+- **Generating API Keys:** Step-by-step guide to generate your unique API keys through the Minekube Browser dashboard.
+- **Using API Keys:** How to include your API key in API requests to authenticate.
+- **Security Best Practices:** Recommendations for securing your API keys.
 
-## Spread the word
-Join us as we explore the features, vision, and community that make Minekube Browser a beacon of innovation in the Minecraft universe. We invite you to be an active participant in this journey, to collaborate, contribute, and most importantly, to enjoy the experience that the Minekube Browser offers.
+[Explore Authentication Details](/browser/api/auth)
+
+## Versioning
+
+To maintain stability and backward compatibility, our API implements a versioning system. This section covers:
+
+- **Version Formats:** Explanation of our semantic versioning format.
+- **Handling Versions:** How to specify API versions in your requests.
+- **Deprecation and Migration:** Guidelines on deprecated features and migrating to newer API versions.
+
+[Learn More About Versioning](/browser/api/versions)
+
+## Endpoints
+
+This section describes all the available API endpoints, their functions, and how to use them. Highlights include:
+
+- **Server Listing Endpoints:** Access information about servers, including details, listings, and management functions.
+- **User and Authentication Endpoints:** How to manage user authentication and user-specific data.
+
+[Detailed Endpoint Information](/browser/api/endpoints)
+
+## Rate Limits
+
+Understanding the rate limits is crucial to ensure fair use and system stability. This section provides:
+
+- **Rate Limit Rules:** Specific limits on the number of requests that can be made to the API.
+- **Best Practices:** Tips on how to handle and respond to rate limit conditions.
+
+[Check Our Rate Limit Policies](/browser/api/ratelimits)
+
+## SDK and Resources
+
+For developers looking to integrate quickly, we offer SDKs and other resources. This section includes:
+
+- **SDK Downloads:** Links to our official SDKs for various programming environments.
+- **Integration Examples:** Practical examples showing how to use the API in common scenarios.
+- **Developer Support:** Information on how to get help if you encounter issues or have questions.
+
+[Access SDK and Developer Resources](/browser/api/developers)
+
+
+## Support
+If you have any questions or issues please join our [Discord](https://minekube.com/discord)
+If you have any questions or issues please join our [Discord](https://minekube.com/discord).
+The team and community is always happy to help you out.
 
-## Getting Started
-Welcome aboard the new chapter of Minecraft server exploration and game building — Welcome to the Minekube Platform.
 
-To get started, check out our [Quicklaunch Guides](./launch/) and [FAQ](./faq/).