Improve Documentation for ReadTheDocs and Codebase

[thatvideoshopguy]

Description

The current documentation for WPWatcher, both on ReadTheDocs and within the codebase, could benefit from improvements to help users better understand the application and make it more accessible to contributors.

Suggested improvements include

1. Expand ReadTheDocs documentation: Enhance the existing Quickstart Guide to include sections on Troubleshooting and Common Issues, Tips for Effective Scanning, Contribution and Support, and License Information. This would provide a more comprehensive guide for users and encourage community involvement.
2. In-code documentation: Add more detailed docstrings and comments throughout the codebase to clarify the purpose and functionality of classes, methods, and functions. This would help contributors better understand the code, making it easier for them to contribute and maintain the project.
3. Best practices and troubleshooting: Provide a section in the ReadTheDocs documentation dedicated to best practices when using WPWatcher, as well as common troubleshooting tips to help users resolve issues they may encounter.

By implementing these improvements, we can make WPWatcher more accessible and user-friendly, ultimately benefiting both end-users and contributors to the project.

[tristanlatr]

Hi @thatvideoshopguy,

Thanks for your suggestions, I'm open to review contributions.

Talk to you later,

[thatvideoshopguy]

Hi @tristanlatr,

Thanks for the response. I'll put together a PR for you to review with some documentation improvements.