search

BitTheByte / Monitorizer

Monitoring framework to detect and report newly found subdomains on a specific target using various scanning tools
257 stars 49 forks source link

Add link to reference documentation #11

Closed Leo-Ryu closed 3 years ago

Leo-Ryu commented 3 years ago

Hi there!

My name is Leo, a CS student at Brown building an automated platform for editable codebase documentation.

I generated documentation for this repository and placed a link in the README. Please feel free to try it out and let me know what you think!

BitTheByte commented 3 years ago

Hello @Leo-Ryu

Thanks for your time and efforts. I only see the reference for the docs with no newly generated docs. could you please double-check?

Thanks

Leo-Ryu commented 3 years ago

Hi @BitTheByte -- I'm migrating over the Get Started doc and README now-- is there anything else you'd like to have in the docs? I'll be sure to tailor them to your needs

BitTheByte commented 3 years ago

Hi @Leo-Ryu. If you had the time, it would be useful to add some gifs or a video demonstrating the written steps. Also I'd love to see the README.md splitted to sections. I really appreciate your efforts. thanks!

Leo-Ryu commented 3 years ago

@BitTheByte I've migrated over the static README and Get Started markdown files https://docs.contour.so/BitTheByte/Monitorizer/README

I'll get started on making gifs of the slack instructions, but is this good enough to merge in so other contributors can easily see/learn?

BitTheByte commented 3 years ago

@Leo-Ryu it looks good enough for now. thanks for your collaboration!

TimothyWang56 commented 3 years ago

@BitTheByte Hi there, and happy holidays! I'm Tim, a student at Brown University, working on this documentation platform with @Leo-Ryu. We're really interested in improving the platform and building it out based on user-feedback, and would appreciate any feedback you might have after having it merged in for a little over a week. Feel free to reach out with any thoughts/critiques!