mtakaki / cachet-url-monitor

URL monitor plugin for cachethq.io
MIT License
124 stars 48 forks source link

Documentation needed? #114

Open Leo-Ryu opened 3 years ago

Leo-Ryu commented 3 years ago

Hello,

I’ve been working on a platform for editable codebase documentation and noticed this repo lacked documentation besides the README. Would it be useful if I generated/hosted docs for this repo?

The platform:

1) has a modern markdown editor to allow people to quickly and easily create new documents/user guides 2) is similar to readthedocs/sphinx in that reads through the codebase and builds/hosts linkable pages describing classes and functions, as well as their usages in the codebase. However unlike readthedocs/sphinx, it doesn't require any configuration to get up and running 3) tracks the github repo so that every build has the latest code

Sincerely hoping I can be of use to you and your project!

Cheers, Leo