Skip to content

[ci skip] Update of Documentation Articles

Mateusz Brawański requested to merge github/fork/jeffreyladd/master into master

Created by: jeffreyladd

Summary

This updates a lot of the Articles to bring it up to date so that the examples and wording is not broken. Also filled out the TODO sections. This does not update by adding pages of things that were just recently added like intents. That documentation will come in a separate PR.

Details

  • Remove all references to the support of Windows 7, mono, etc.
  • Fix all broken Links
  • Add new cross-references to all MD pages and update all links
  • Add Custom Handler page
  • Update all screenshots if they are too far out of date.
  • Update all code examples so they are now working
  • Add Help formatter page
  • Fill in all TODO pages and sections
  • Rewrite hosting options page
  • Rewrite Bot Application page
  • Rewrite Basic Bot page
  • Add Custom Logging page
  • Add Exceptions to XMLDocs for the API Docs
  • Update Event Reference Page as parameterless events are going bye-bye shortly
  • Do Final pass at grammar, sentence structure, etc
  • Create FAQ Page at the root

Notes

I personally have no knowledge of VoiceNext or Lavalink so I did not add info there that was not already in the announcements channel in Discord. If someone wants to update those on their own or I can give Contrib to someone on my PR and they can add it in as well.

Side Note

This is not complete yet but wanted to gauge input based on what has been updated thus far.
Final note, I have published a working copy of what has been done thus far at https://jeffreyladd.github.io/docs-dsharpplus. Although the images are not working cause linkage problems, they are actually there and will work once as this is merged in and published (confirmed when running DocFX locally).

Merge request reports