Skip to content

docs: Fix more broken links #1436

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 1 commit into from
Jun 3, 2023
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
Expand Up @@ -18,6 +18,6 @@
{ .annotate }

1. This connects the bot to the author's voice channel if we are not already connected
2. Check out the [Voice Support Guide](/Guides/22 Voice.html) for more info on audio playback
2. Check out the [Voice Support Guide](interactions.py/Guides/23 Voice/) for more info on audio playback

::: interactions.models.internal.active_voice_state
2 changes: 1 addition & 1 deletion docs/src/Guides/01 Getting Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,4 +110,4 @@ Congratulations! You now have a basic understanding of this library.
If you have any questions check out our other guides, or join the
--8<-- "discord_inv.md"

For more examples, check out the [examples page](/Guides/90 Example)
For more examples, check out the [examples page](/interactions.py/Guides/90 Example)
2 changes: 1 addition & 1 deletion docs/src/Guides/03 Creating Commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -519,4 +519,4 @@ There also is `on_command` which you can overwrite too. That fires on every inte

If your bot is complex enough, you might find yourself wanting to use custom models in your commands.

To do this, you'll want to use a string option, and define a converter. Information on how to use converters can be found [on the converter page](/Guides/08 Converters).
To do this, you'll want to use a string option, and define a converter. Information on how to use converters can be found [on the converter page](/interactions.py/Guides/08 Converters/).
8 changes: 4 additions & 4 deletions docs/src/Guides/100 Migration From D.py.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@
- These work mostly the same, with a few notable changes:
- Your setup function doesn't need to do `bot.add_cog()`. Simply call `MyCog(bot)`, and it'll automatically register itself.
- Extensions already define `self.bot`, you don't need to do that in your `__init__` function.
- For a full example, see [here](/Guides/20 Extensions/)
- For a full example, see [here](/interactions.py/Guides/20 Extensions/)

4. Event handlers
- Register event handlers with `@interactions.listen`
- Where possible, we use the official names for events, most notably `on_message_create` instead of dpy's `on_message`.
- A full list can be found [here](/interactions.py/API Reference/API Reference/events/discord/).
- Event details are stored on a model, passed as a single parameter. (eg: `on_member_update(before, after)` becomes `on_member_update(event)`, where event has a `.before` and `.after`.
- `on_ready` is called whenever the gateway resumes. If you are looking to run stuff *once* upon startup, use the `on_startup` handler instead.
- For more details, read [the Events guide](/Guides/10 Events).
- For more details, read [the Events guide](/interactions.py/Guides/10 Events).

5. Migrating your commands
- If you were already using dpy's command extension, migrating to slash commands is fairly simple. You just need to convert the decorators as per the [Slash Commands guide](/Guides/03 Creating Commands/)
- If you wish to keep using prefixed commands (sometimes called message or text-based commands), you can use our prefixed command extension, which has an [extensive guide for them](/Guides/07 Creating Prefixed Commands). The syntax should be very similar to discord.py with a few exceptions.
- If you were already using dpy's command extension, migrating to slash commands is fairly simple. You just need to convert the decorators as per the [Slash Commands guide](/interactions.py/Guides/03 Creating Commands/)
- If you wish to keep using prefixed commands (sometimes called message or text-based commands), you can use our prefixed command extension, which has an [extensive guide for them](/interactions.py/Guides/07 Creating Prefixed Commands). The syntax should be very similar to discord.py with a few exceptions.
- If you were manually handling commands with `on_message`, you'll probably need to figure it out yourself, as this guide doesn't know how you wrote your parser. Consider using the provided command handlers.

???+ Note
Expand Down
2 changes: 1 addition & 1 deletion docs/src/Guides/40 Tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ To start a task that has been created, you need to run the `Task.start()` method
```
{ .annotate }

1. See [Events](/Guides/10 Events/) for more information
1. See [Events](/interactions.py/Guides/10 Events/) for more information

=== ":two: Manual Registration"

Expand Down
2 changes: 1 addition & 1 deletion docs/src/Guides/99 2.x Migration_NAFF.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ from interactions.ext import prefixed_commands
client = Client(..., intents=Intents.GUILD_MESSAGES | ...)
prefixed_commands.setup(client)
```
From here it's more or less the same as before. You can find a guide on how to use prefixed commands [here](/Guides/26 Prefixed Commands/).
From here it's more or less the same as before. You can find a guide on how to use prefixed commands [here](/interactions.py/Guides/26 Prefixed Commands/).

## Hybrid Commands
For now, hybrid commands are not supported, but they will be in the future.
Expand Down