/Knight_Documenter

A tool designed to speed up the documentation pipeline

Primary LanguageC#

Hello and Welcome to the Knight Documenter Wiki!

What is Knight Documenter?

Knight Documenter is a tool for programmers that will speed up the documentation pipeline by allowing a user to generate documentation at the click of a button! It will generate documentation such as comment extraction, class diagrams and even program flow charts! Then it will let the user choose from a variety of formats such as html files (for Wiki's like this one!).

Can I help out?

If you really want to help out/ add to the project then feel free to! I'll overview any addition/ fix and if I believe it to be a good addition then I shall add it in and give you credit both in code and here on the Wiki!

I noticed something wrong with your code....

If you've noticed an error within the code the please let me know ASAP. You can do that by either submitting an issue here on Github or feel free to hop over to my website @jaredscode.me/contact/ and use my contact form with the subject line "Knight Documenter Issue". Credit will be given both in code and here on the Wiki for the find!

How can I keep up to date with how Knight Documenter is going?

If you want to keep up with the project then you have a few options. You can either star the project here on Github, follow me on twitter @jaredscode, visit my website for blog posts or like my page on Facebook at /jaredscode