Skip to content

Documentation improvement #124

@RedNeath

Description

@RedNeath

Hey!

I like your job 👍 However, when I tried using this bot, I struggled a little bit when setting the personnal access token up.

I tried opening a pull request with an update on the main README file, but I wasn't allowed to do it, so I figured I could tell you about it in this isssue.

This is what I wanted to add in the README (at the end of the env section):

> **NOTE:**  
> As the bot uses the GitHub API, the Personnal Access Token (or PAS) will have to be "Fine-grained".
>
> Also, make sure you let the token have administrator rights on the repo you want to set the bot up on, otherwise the deletion of a forum post will cause it to crash.

Which outputs as:

NOTE:
As the bot uses the GitHub API, the Personnal Access Token (or PAS) will have to be "Fine-grained".

Also, make sure you let the token have administrator rights on the repo you want to set the bot up on, otherwise the deletion of a forum post will cause it to crash.


Related to the addition in the README, do you plan to catch exceptions on calls to GitHub or Discord APIs (at least in production mode), so that it doesn't necessarily crash when a request fails?
If you need help for that, I'd be glad to take part in the development process 😃

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions