Overhaul Documentation

.github/CONTRIBUTING.md

@@ -8,10 +8,9 @@ The following is a set of guidelines for contributing to the repository. These a
 
 Generally speaking questions are better suited in our resources below.
 
-- The official support server: https://discord.gg/UCXwPR7Pew
-- The Discord API server under #python_discord-py: https://discord.gg/discord-api
-- [The FAQ in the documentation](https://pycord.readthedocs.io/en/latest/faq.html)
-- [StackOverflow's `discord.py` tag](https://stackoverflow.com/questions/tagged/discord.py)
+- The official support server: https://pycord.dev/discord
+- [The FAQ in the documentation](https://docs.pycord.dev/en/master/faq.html)
+- [StackOverflow's `pycord` tag](https://stackoverflow.com/questions/tagged/pycord)
 
 Please try your best not to ask questions in our issue tracker. Most of them don't belong there unless they provide value to a larger audience.
 
@@ -26,7 +25,7 @@ Please be aware of the following things when filing bug reports.
     - Guidance on **how to reproduce the issue**. Ideally, this should have a small code sample that allows us to run and see the issue for ourselves to debug. **Please make sure that the token is not displayed**. If you cannot provide a code snippet, then let us know what the steps were, how often it happens, etc.
     - Tell us **what you expected to happen**. That way we can meet that expectation.
     - Tell us **what actually happens**. What ends up happening in reality? It's not helpful to say "it fails" or "it doesn't work". Say *how* it failed, do you get an exception? Does it hang? How are the expectations different from reality?
-    - Tell us **information about your environment**. What version of discord.py are you using? How was it installed? What operating system are you running on? These are valuable questions and information that we use.
+    - Tell us **information about your environment**. What version of Pycord are you using? How was it installed? What operating system are you running on? These are valuable questions and information that we use.
 
 If the bug report is missing this information then it'll take us longer to fix the issue. We will probably ask for clarification, and barring that if no response was given then the issue will be closed.
 
@@ -43,12 +42,14 @@ deciding to ignore type checking warnings.
 
 By submitting a pull request, you agree that; 1) You hold the copyright on all submitted code inside said pull request; 2) You agree to transfer all rights to the owner of this repository, and; 3) If you are found to be in fault with any of the above, we shall not be held responsible in any way after the pull request has been merged.
 
-### Git Commit Guidelines
+## Git Commit Styling
 
-- Use present tense (e.g. "Add feature" not "Added feature")
-- Limit all lines to 72 characters or less.
-- Reference issues or pull requests outside of the first line.
-    - Please use the shorthand `#123` and not the full URL.
-- Commits regarding the commands extension must be prefixed with `[commands]`
+Not following this guideline could lead to your pull being squashed for a cleaner commit history
 
-If you do not meet any of these guidelines, don't fret. Chances are they will be fixed upon rebasing but please do try to meet them to remove some of the workload.
+Some style guides we would recommed using in your pulls:
+
+The [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) style is a very widely used style and a good style to start with.
+
+The [gitmoji](https://gitmoji.dev) style guide would make your pull look more lively and different to others.
+
+We don't limit nor deny your pulls when you're using another style although, please make sure it is appropriate and makes sense in this library.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -17,6 +17,7 @@ body:
         - The core library
         - discord.ext.commands
         - discord.ext.tasks
+        - discord.ext.pages
         - The documentation
     validations:
       required: true

.github/SECURITY.md

@@ -4,9 +4,9 @@
 
 | Version | Supported          |
 | ------- | ------------------ |
-| 2.0.0   | :white_check_mark: |
-| 1.7.x   | :white_check_mark: |
-| < 1.7.3 | :x:                |
+| <2.0.0  | :white_check_mark: |
+| 1.7.3   | :x:                |
+| >1.7.x  | :x:                |
 
 ## Reporting a Vulnerability
 

.github/workflows/docs.yml

@@ -0,0 +1,24 @@
+name: Docs
+
+on: [push, pull_request]
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ 3.8 ]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install -U pip
+        pip install -U sphinx sphinxcontrib-trio aiohttp sphinxcontrib-websupport myst-parser
+    - name: Compile to html
+      run: |
+        cd docs
+        make html

.gitignore

@@ -10,7 +10,6 @@ docs/crowdin.py
 *.mp3
 *.m4a
 *.wav
-*.png
 *.jpg
 *.flac
 *.mo
@@ -21,3 +20,5 @@ __pycache__
 .vs/slnx.sqlite
 env/
 build/
+node_modules/*
+test.py

.readthedocs.yml

@@ -10,7 +10,7 @@ sphinx:
   builder: html
 
 python:
-  version: 3.8
+  version: "3.8"
   install:
     - method: pip
       path: .

README.rst

@@ -1,7 +1,7 @@
-pycord
-==========
+Pycord
+======
 
-.. image:: https://discord.com/api/guilds/881207955029110855/embed.png
+.. image:: https://img.shields.io/discord/881207955029110855?color=blue&label=discord
    :target: https://pycord.dev/discord
    :alt: Discord server invite
 .. image:: https://img.shields.io/pypi/v/py-cord.svg
@@ -14,15 +14,22 @@ pycord
    :target: https://pypi.python.org/pypi/py-cord
    :alt: PyPI downloads
 
-A fork of discord.py. PyCord is a modern, easy to use, feature-rich, and async ready API wrapper for Discord written in Python.
+A fork of discord.py. Pycord is a modern, easy to use, feature-rich, and async ready API wrapper for Discord written in Python.
+
+What Happened to Discord.py?
+----------------------------
+Rapptz, also known as Danny, the maintainer and core developer of discord.py will no longer be updating it. Here's his `Full explanation <https://gist.github.com/Rapptz/4a2f62751b9600a31a0d3c78100287f1>`__ and an `FAQ <https://gist.github.com/Rapptz/4a2f62751b9600a31a0d3c78100287f1#FAQ>`__.
+
+
+Pycord v1.7.3 is the same as discord.py v1.7.3, however, Pycord v2.0 will support newer features of the API such as slash commands, context menus, scheduled events, timeouts, and others.
 
 Key Features
--------------
+------------
 
 - Modern Pythonic API using ``async`` and ``await``.
 - Proper rate limit handling.
 - Optimised for both speed and memory usage.
-- Supports Slash Commands, Context Menus and Message Components.
+- Full Application Command Support
 
 Installing
 ----------
@@ -69,7 +76,7 @@ To install the development version, do the following:
 
 
 Optional Packages
-~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~
 
 * `PyNaCl <https://pypi.org/project/PyNaCl/>`__ (for voice support)
 * `aiodns <https://pypi.org/project/aiodns/>`__, `Brotli <https://pypi.org/project/Brotli/>`__, `cchardet <https://pypi.org/project/cchardet/>`__ (for aiohttp speedup)
@@ -78,10 +85,10 @@ Optional Packages
 Please note that while installing voice support on Linux, you must install the following packages via your preferred package manager (e.g. ``apt``, ``dnf``, etc) BEFORE running the above commands:
 
 * libffi-dev (or ``libffi-devel`` on some systems)
-* python-dev (e.g. ``python3.6-dev`` for Python 3.6)
+* python-dev (e.g. ``python3.10-dev`` for Python 3.10)
 
 Quick Example
---------------
+-------------
 
 .. code:: py
 
@@ -100,8 +107,8 @@ Quick Example
 
     bot.run("token")
 
-Normal Commands Example
-~~~~~~~~~~~~~
+Traditional Commands Example
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. code:: py
 
@@ -121,9 +128,9 @@ You can find more examples in the examples directory.
 Note: Make sure you do not reveal your bot token to anyone, it can grant access to your bot.
 
 Links
-------
+-----
 
 - `Documentation <https://docs.pycord.dev/en/master/index.html>`_
-- `Official Discord Server <https://pycord.dev/discord>`_
-- `Discord Developers <https://discord.gg/discord-developers>`_
-- `Discord API <https://discord.gg/discord-api>`_
+- `Our Official Discord Server <https://pycord.dev/discord>`_
+- `Official Discord Developers Server <https://discord.gg/discord-developers>`_
+- `Unofficial Discord API Server <https://discord.gg/discord-api>`_

discord/__init__.py

@@ -63,6 +63,7 @@
 from .commands import *
 from .cog import Cog
 from .welcome_screen import *
+from .scheduled_events import ScheduledEvent, ScheduledEventLocation
 
 
 class VersionInfo(NamedTuple):

discord/__main__.py

@@ -286,7 +286,7 @@ def add_newcog_args(subparser: argparse._SubParsersAction) -> None:
     parser.add_argument('--full', help='add all special methods as well', action='store_true')
 
 def parse_args() -> Tuple[argparse.ArgumentParser, argparse.Namespace]:
-    parser = argparse.ArgumentParser(prog='discord', description='Tools for helping with discord.py')
+    parser = argparse.ArgumentParser(prog='discord', description='Tools for helping with Pycord')
     parser.add_argument('-v', '--version', action='store_true', help='shows the library version')
     parser.set_defaults(func=core)