You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Proposal: Comprehensive Documentation Overhaul & User Guide #272
I've been following Web-Check and I love the tool. However, I noticed that as the project grows, the documentation could benefit from a more structured approach to help new users and contributors.
Create a detailed "Getting Started" guide for non-technical users.
Structure the API reference clearly.
Add a "Troubleshooting" section based on common issues.
I'm happy to contribute the initial README improvements for free, but I'm also available for a more extensive, paid documentation contract if you're looking to take the project's UX to the next level.
Activity
lissy93 commentedon Sep 28, 2026
Done in #341 :)