#272·web-check

Proposal: Comprehensive Documentation Overhaul & User Guide

Author: umutcetiner07Created Jan 9, 2026Updated Jan 9, 2026

Hi @Lissy93,

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.

I am a Technical Documentation Specialist and I've recently completed a similar overhaul for another financial project ( Reference: https://github.com/umutcetiner07/primavera-financial )

I'm offering to:

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.

Looking forward to your thoughts!