I think would be better to reference this .env.example in this section instead of explicitly mention the ENV required (this will only make that we have to update it each time ENVs are updated.), then explain a bit more about the configuration, for example add links to the documentation of Discord where explain where to get each one of those keys, and add short explanations about what is each one of them.
Checklist
This issue can be closed when the following tasks are complete:
[ ] Configuration sections not only explain what are the env variables that we need but it uses a reference to .env.example file to explain it
[ ] Configuration section helps the developer to get those variables explaining where he can found it
[ ] Configuration section gives a TLDR of what are those KEYS (a summary, then the links to the complete documentation)
Explanation
In this PR https://github.com/TeamNovaSoft/discord-bot/pull/5 it was missed this comment:
I think would be better to reference this .env.example in this section instead of explicitly mention the ENV required (this will only make that we have to update it each time ENVs are updated.), then explain a bit more about the configuration, for example add links to the documentation of Discord where explain where to get each one of those keys, and add short explanations about what is each one of them.
Checklist
This issue can be closed when the following tasks are complete:
References
Related issues