From e2eb9e804942c69c366f6d61617779421b9dba6a Mon Sep 17 00:00:00 2001
From: nova <110734810+novanai@users.noreply.github.com>
Date: Mon, 7 Oct 2024 20:06:26 +0100
Subject: [PATCH] Update Guides index page (#222)
---
docs/guides/index.md | 101 ++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 99 insertions(+), 2 deletions(-)
diff --git a/docs/guides/index.md b/docs/guides/index.md
index 012675fe..29d0738e 100644
--- a/docs/guides/index.md
+++ b/docs/guides/index.md
@@ -1,5 +1,102 @@
+---
+title: Guides
+description: Guides on how to use miru
+hide:
+ - toc
+search:
+ exclude: true
+---
+
# Guides
-This section contains all the guides for miru.
+In this section you can find various in-depth guides that explain specific topics in detail. There's also fully functional [examples](https://github.com/hypergonial/hikari-miru/tree/main/examples) in the repository, if you prefer to learn that way.
+
+If you think something is missing or inaccurate, please [open an issue](https://github.com/hypergonial/hikari-miru/issues/new/choose)!
+
+
+
+- :material-file-tree:{ .lg .middle } **Client as State**
+
+ ---
+
+ Learn how to access the `miru` client anywhere in the bot to
+ manage views and modals.
+
+ [:octicons-arrow-right-24: Learn more](./client_state.md)
+
+- :material-pen-plus:{ .lg .middle } **Editing Items**
+
+ ---
+
+ Learn how to edit views after they've already been sent
+ on Discord.
+
+ [:octicons-arrow-right-24: Learn more](./editing_items.md)
+
+- :octicons-multi-select-16:{ .lg .middle } **Select Menus**
+
+ ---
+
+ Learn how to create and use all the different types
+ of select menus.
+
+ [:octicons-arrow-right-24: Learn more](./selects.md)
+
+- :fontawesome-solid-road-barrier:{ .lg .middle } **View Checks & Timeout Handling**
+
+ ---
+
+ Create checks and handle timeouts on views.
+
+ [:octicons-arrow-right-24: Learn more](./checks_timeout.md)
+
+- :material-fire:{ .lg .middle } **Error Handling**
+
+ ---
+
+ Handle errors raised by views.
+
+ [:octicons-arrow-right-24: Learn more](./error_handling.md)
+
+- :material-file-document:{ .lg .middle } **Modals**
+
+ ---
+
+ Build, send and respond to modals.
+
+ [:octicons-arrow-right-24: Learn more](./modals.md)
+
+- :material-timer:{ .lg .middle } **Persistent Views**
+
+ ---
+
+ Create views which persist through bot restarts.
+
+ [:octicons-arrow-right-24: Learn more](./persistent_views.md)
+
+- :material-button-pointer:{ .lg .middle } **Navigators**
+
+ ---
+
+ Create button-controlled menus to view multiple pages of data.
+
+ [:octicons-arrow-right-24: Learn more](./navigators.md)
+
+- :material-menu:{ .lg .middle } **Menus**
+
+ ---
+
+ Create views with multiple pages, with the ability to
+ set custom content and button on each page.
+
+ [:octicons-arrow-right-24: Learn more](./menus.md)
+
+- :material-lightning-bolt:{ .lg .middle } **Migrating from v3**
+
+ ---
+
+ Still using v3? Learn how to migrate to v4.
+
+ [:octicons-arrow-right-24: Learn more](./migrating_from_v3.md)
-If you think anything is missing or incorrect, feel free to open an issue or pull request.
+