Skip to content

docs: slightly improve search experience #1576

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

Merged
Merged
Show file tree
Hide file tree
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
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

# Hybrid Commands Index

- [Context](context)
Expand Down
5 changes: 5 additions & 0 deletions docs/src/API Reference/API Reference/ext/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

# Ext Index

These files contain useful features that help you develop a bot
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

# Prefixed Commands Index

- [Command](command)
Expand Down
5 changes: 5 additions & 0 deletions docs/src/API Reference/API Reference/models/Discord/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

# Discord Models Index

- [Activity](activity)
Expand Down
5 changes: 5 additions & 0 deletions docs/src/API Reference/API Reference/models/Internal/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

# Internal Models Index

- [Active Voice State](active_voice_state)
Expand Down
5 changes: 5 additions & 0 deletions docs/src/API Reference/API Reference/models/Misc/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

# Misc Models Index

- [Iterator](iterator)
5 changes: 5 additions & 0 deletions docs/src/API Reference/API Reference/models/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

# Models

Within these pages, you will find a list of all available models within interactions.py.
Expand Down
5 changes: 5 additions & 0 deletions docs/src/Guides/01 Getting Started.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Introduction

Ready to get your Python on and create a Discord bot? This guide's got you covered with installation options and a basic bot code example.
Expand Down
5 changes: 5 additions & 0 deletions docs/src/Guides/02 Creating Your Bot.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Creating Your Bot

To make a bot on Discord, you must first create an application on Discord. Thankfully, Discord has made this process very simple:
Expand Down
5 changes: 5 additions & 0 deletions docs/src/Guides/03 Creating Commands.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Slash Commands

So you want to make a slash command (or interaction, as they are officially called), but don't know how to get started?
Expand Down
5 changes: 5 additions & 0 deletions docs/src/Guides/04 Context Menus.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Context Menus

Context menus are interactions under the hood. Defining them is very similar.
Expand Down
5 changes: 5 additions & 0 deletions docs/src/Guides/05 Components.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Components

Components (Buttons, Select Menus and soon Text Input Fields) can be added to any message by passing them to the `components` argument in any `.send()` method.
Expand Down
5 changes: 5 additions & 0 deletions docs/src/Guides/06 Modals.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Modals

Modals are basically popups which a user can use to send text information to your bot. As of the writing of this guide, you can use two components in a modal:
Expand Down
5 changes: 5 additions & 0 deletions docs/src/Guides/08 Converters.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Converters

If your bot is complex enough, you might find yourself wanting to use custom models in your commands. Converters are classes that allow you to do just that, and can be used in both slash and prefixed commands.
Expand Down
5 changes: 5 additions & 0 deletions docs/src/Guides/10 Events.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Events

Events (in interactions.py) are pieces of information that are sent whenever something happens in Discord or in the library itself - this includes channel updates, message sending, the bot starting up, and more.
Expand Down
5 changes: 5 additions & 0 deletions docs/src/Guides/20 Extensions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Extensions

## Introduction
Expand Down
5 changes: 5 additions & 0 deletions docs/src/Guides/22 Live Patching.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Live Patching

interactions.py has a few built-in extensions that add some features, primarily for debugging. One of these extensions that you can enable separately is to add [`jurigged`](https://github.com/breuleux/jurigged) for live patching of code.
Expand Down
5 changes: 5 additions & 0 deletions docs/src/Guides/23 Voice.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Voice Support

So you want to start playing some 🎵tunes🎶 in voice channels? Well let's get that going for you.
Expand Down
5 changes: 5 additions & 0 deletions docs/src/Guides/24 Localisation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Localising

So your bot has grown, and now you need to ~~localize~~ localise your bot. Well thank god we support localisation then, huh?
Expand Down
5 changes: 5 additions & 0 deletions docs/src/Guides/25 Error Tracking.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Error Tracking

So, you've finally got your bot running on a server somewhere. Chances are, you're not checking the console output 24/7, looking for exceptions.
Expand Down
5 changes: 5 additions & 0 deletions docs/src/Guides/26 Prefixed Commands.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Creating Prefixed Commands

Prefixed commands, called by Discord as "text commands" and sometimes called "message commands" (not to be confused with Context Menu Message Commands), are commands that are triggered when a user sends a normal message with a designated "prefix" in front of them.
Expand Down
5 changes: 5 additions & 0 deletions docs/src/Guides/30 Pagination.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Pagination

> Pagination, also known as paging, is the process of dividing a document into discrete pages, either electronic pages or printed pages.
Expand Down
5 changes: 5 additions & 0 deletions docs/src/Guides/40 Tasks.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Tasks

Tasks are background processes that can be used to asynchronously run code with a specified trigger.
Expand Down
5 changes: 5 additions & 0 deletions docs/src/Guides/80 Sharding.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Sharding

Oh damn, your bot is getting pretty big, huh? Well I guess its time we discuss sharding.
Expand Down
5 changes: 5 additions & 0 deletions docs/src/Guides/90 Example.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Examples

## `main.py`
Expand Down
5 changes: 5 additions & 0 deletions docs/src/Guides/97 Migration From D.py.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Migrating from discord.py

1. interactions.py requires python 3.10 (as compared to dpy's 3.5), you may need to upgrade python.
Expand Down
5 changes: 5 additions & 0 deletions docs/src/Guides/98 Migration from 4.X.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Migrating from 4.X

Version 5.X (and beyond) is a major rewrite of interactions.py compared to 4.X, though there have been major improvements to compensate for the change. 5.X was designed to be more stable and flexible, solving many of the bugs and UX issues 4.X had while also adding additional features you may like.
Expand Down
5 changes: 5 additions & 0 deletions docs/src/Guides/99 2.x Migration_NAFF.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 3
---

# Migrating from NAFF

Oh hey! So you're migrating from NAFF to interactions.py? Well lets get you sorted.
Expand Down
5 changes: 5 additions & 0 deletions docs/src/Guides/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

Let's be honest; reading API documentation is a bit of a pain.
These guides are meant to help you get started with the library and offer a point of reference.

Expand Down
2 changes: 2 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ hide:
- navigation
- toc
- feedback
search:
exclude: true
---

We hope this documentation is helpful for you, but don't just ++ctrl+c++ and ++ctrl+v++.
Expand Down