question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Documentation Requiring Re-reviews

See original GitHub issue

Summary

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:closed
  • Created 3 years ago
  • Comments:10 (1 by maintainers)

github_iconTop GitHub Comments

1reaction
MrCakeSlayercommented, Apr 25, 2022

@HarrySpyrou yeah you could post them here or even open a PR for them. Either is fine.

1reaction
csmircommented, Feb 3, 2022

Will take up this chore

Read more comments on GitHub >

github_iconTop Results From Across the Web

The Documentation Review Process: A Practical Guide
When conducting a documentation review, you need to look for several things, including the quality of the writing, the structure of the document...
Read more >
What is a Requirements Review: Definition, Process & Tools
A requirements review is a manual process that involves people from both client and contractor organizations. They check the requirements document for anomalies ......
Read more >
【Documentation Review Process: What is It & How to do It ...
Documentation review is the process of analyzing and evaluating existing documents to ensure their accuracy, completeness, and relevance. It helps organizations ...
Read more >
How to review documents in 5 easy steps
A document review is the process of checking a document to make sure it's ready to be used or published. This usually involves...
Read more >
Document Review: Meaning, Purpose, and More
What is a document review? · The document is approved: You are satisfied with the document, and no changes are needed. · The...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found