Code Monkey home page Code Monkey logo

guide's Introduction

Disnake Banner

Disnake Guide (WIP)

Discord server invite Commit activity GitHub checks

Welcome! The purpose of this guide is to make your journey with disnake easier, whether you're an experienced developer just getting into coding Discord bots, or an advanced bot developer who has decided to proceed with disnake as their library of choice.

The concept we will be going over, include:

  • How to get started on working with bots;
  • How to create and organize commands, using cogs/extensions;
  • Working with databases (such as sqlite and mongodb (motor));
  • Using the AutoShardedClient class to shard your bot;
  • A plethora of examples with popular topics along with in-depth explanation, and much more!

This guide will showcase the various features and events that our library has, while giving you an idea of how these functions work together as well as how the syntax looks in production.

Development

For more info on development/contributions, see CONTRIBUTING.md.


DocumentationGuideDiscord ServerDiscord Developers


guide's People

Contributors

abhigyantrips avatar dlchamp avatar elenakrittik avatar equenos avatar helish88 avatar onerandomusername avatar osesem avatar shiftinv avatar skelmis avatar snipy7374 avatar victorsitou avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

guide's Issues

Classes Tutorial

Expands on

guide.disnake.dev/getting-started/*

Title

Tutorial For Classes

Description

I will write a tutorial on how to use commands.Bot / commands.InteractionBot and the AutoSharded versions. I just need to know whether I should work on this, because if I make a PR right now and you guys don't like it I wasted my time.

Additional context

No response

Would you like to implement this yourself?

Yes, I will be contributing this addition.

Add page for Modals and TextInputs

Expands on

No response

Title

Modals and Text Inputs

Description

As modals will be added to the library in DisnakeDev/disnake#253, it's a good idea to cover this by the time the PR is merged - in order to clarify how the feature will be used.

We're on a time limit, gotta do this fast. :P

Additional context

No response

Would you like to implement this yourself?

Yes, I will be contributing this addition.

Edit Get or Fetch the channel on "How do i send a message to a specific channel" FAQ paragraph

Affected pages

Current text

  • guide.disnake.dev/faq/general
    • P3 L1 - "You must fetch the channel directly and then call the appropriate method. Example:"
    • P3 L2 - channel = bot.get_channel(12324234183172)

Recommended text

  • guide.disnake.dev/faq/general
    • P3 L1 - "You must fetch the channel directly and then call the appropriate method. Example:" -> "You must get or fetch the channel directly and then call the appropriate method. Example:"
    • P3 L2-L3
      from:
      channel = bot.get_channel(12324234183172)
      await channel.send("hello")
      to:
      channel = bot.get_channel(12324234183172) or await bot.fetch_channel(12324234183172)
      # if Bot.get_channel returns None because the channel is not in the Bot's cache then it'll 
      # make an API call to fetch the channel
      
      await channel.send("hello")

Additional context

No response

Feat: Complete interactions/buttons page

Expands on

guide.disnake.dev/interactions/buttons

Title

Update page at /interactions/buttons

Description

This page currently only provides examples for low-level implementations and has headings that are incomplete.

Additional context

No response

Would you like to implement this yourself?

Yes, I will be contributing this addition.

Build an FAQ section, with categories.

The current plan for this is to inherit the FAQs from the documentation as placeholder, and then edit/add on to that.

Since this is in a separate section, it shouldn't conflict with commits to other parts of the content or the site. I'm opening this as a separate issue since this will take quite some time. Will possibly create a separate branch.

Add template for Issues and PRs in `.github`

This is currently unimportant, but will be required in the next month or so - when basic file structure is complete and external input on articles (mostly under Popular Topics/Misc.) will be necessary.

Applications.commands scope on inviting

Expands on

000-prerequisites/003-inviting-your-bot/

Title

applications.commands scope

Description

need this scope and why, what you can't do with it

Additional context

can link to this from why won't my guild commands sync/ why are my guild commands hitting 403s?

Would you like to implement this yourself?

No, I am only suggesting this addition.

Update to the latest Docusaurus version. (2.0.0-beta.15)

I'm leaving this as a separate issue, since there are some conflicts and breaking changes I'll have to rewrite for. Most changes during the version change will be related to the config. files and the components, So this shouldn't affect the main content workflow.

A few reasons for switching over to the new version, since it isn't necessarily compulsory:

  • Auto-collapsing sibling categories, which will clear up the clutter in the sidebar;
  • HTML overriding, can be useful in a few places;
  • Disabling certain components in dev, which will reduce the payload on the contributor's machine;
  • Contextual search being default, will affect Algolia DocSearch indexing.

The breaking changes for which we'll have to refactor:

  • All theme hooks have now been moved to @docusaurus/theme-common, and now come under useColorMode. Since we have multiple components depending on this, it'll have to be rewritten.
  • The components that have been manually swizzled (named MDXPage and MDXComponents) will have to be reswizzled and refactored with the changes made earlier. This is important since those components underwent quite a few changes.

All of this is covered in greater detail at https://docusaurus.io/changelog/2.0.0-beta.15.

Add the ability to see build previews on pull requests

It would be nice to get build previews in pull requests for the purposes of reviews. This allows contributors and anyone else who wishes to review a simplistic way to see how the changes made in a given pull request will actually look on the final site before they make it to the final site.

Inspiration taken from the nextcord pull requests system. See an example in this pr nextcord/nextcord#746

feat: update popular-topics/webhooks

Expands on

guide.disnake.dev/popular-topics/webhooks

Title

Update the page at popular-topics/webhooks

Description

This page appears to still be marked as "WIP" and needs to be updated. The cats are cute, but it needs content. 😺

Additional context

No response

Would you like to implement this yourself?

Yes, I will be contributing this addition.

Logging Page

Expands on

https://guide.disnake.dev/popular-topics

Title

Logging Page

Description

Here I will write a page that shows how to use logging with disnake and how to use it in general. And I know you guys might say: There is already a python docs page for this!! but ours will be easier to read for the beginner programmer.

Additional context

No response

Would you like to implement this yourself?

Yes, I will be contributing this addition.

Update page with examples and more information covering the various SelectMenus available within Disnake

Expands on

guide.disnake.dev/interactions/select-menus

Title

Update page at /interactions/select-menus

Description

This page currently shows "WIP". I'm opening this issue so that I can link to it as part of my PR where I have updated this page to show relevant examples and information on the topic.

Additional context

The contributing guidelines link is broken

Would you like to implement this yourself?

Yes, I will be contributing this addition.

Update to the latest Docusaurus version. (2.0.0-beta.17)

It's that time again. This one introduces a bunch of features that'd refresh the look of the site.

The important new features:

  • The theme toggle/slider has been replaced by a theme button, which takes up less space and matches the curvature of the search bar (It looks better, trust me.)
  • Breadcrumbs show the structure/location of the pages - like a mini directory structure at the top.
  • An option to disable the search page located at https://guide.disnake.dev/search. I think it's a good idea to do that, but this is open to discussion.

Breaking changes? Yes:

  • Since the theme toggle is now a button, there is no need of a switchConfig.
  • All swizzled components will need to be re-swizzled and re-customized.

Should be a pretty easy task to resolve those. There were also a bunch of bugfixes that would polish things up.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.