Documentation Requiring Re-reviews
See original GitHub issueSummary
There are several articles within the documentation that may need additional re-reviews for clarity and additional corrections for content that may be misleading or incorrect. Specifically, the following pages:
https://github.com/discord-net/Discord.Net/blob/dev/docs/faq/commands/general.md https://github.com/discord-net/Discord.Net/blob/dev/docs/guides/introduction/intro.md https://github.com/discord-net/Discord.Net/blob/dev/docs/guides/getting_started/terminology.md https://github.com/discord-net/Discord.Net/blob/dev/docs/guides/voice/sending-voice.md https://github.com/discord-net/Discord.Net/blob/dev/docs/guides/commands/dependency-injection.md
…and potentially many other articles.
The Problem
Some of these articles feature terminologies or descriptions that are inaccurate or out-of-date, potentially leading to bad or smelly code. For example, our documentation regarding DI can be somewhat misleading for beginners that are not yet familiar with the concept of Inversion of Control or Dependency Injection. Our example code suggests AddSingleton
for all implementations, which may or may not be ideal depending on the underlying service without additional explanation. While this is not necessarily within the scope of library documentation, additional comments could be made regarding DI instead of just few lines of words and a code snippet.
Issue Analytics
- State:
- Created 3 years ago
- Comments:10 (1 by maintainers)
Top GitHub Comments
@HarrySpyrou yeah you could post them here or even open a PR for them. Either is fine.
Will take up this chore