Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Guides index page #222

Merged
merged 1 commit into from
Oct 7, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 99 additions & 2 deletions docs/guides/index.md
Original file line number Diff line number Diff line change
@@ -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)!

<div class="grid cards" markdown>

- :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.
</div>