Docs Improvements

Thanks to @cortesi, we have fantastic revamped docs. 🎉 🍰 To not interfere with his final touches, I’m collecting minor things here:

• We definitely need a link back to mitmproxy.org. We’ll have users land on the docs and they won’t find a way to download the thing. 😄 I think it’d be great to have the mitmproxy.org header in the docs as well.
• To the surprise of @cortesi, we do support transparent mode on Windows. That should be added.
• Clicking directly on “Docs” should take us to the latest version, not ReadTheDocs.
• “Linux fully transparent mode” seems to be way to prominent on https://www-test.mitmproxy.org/docs/latest/howto-transparent/ and should probably be moved to the bottom.
• We need to mention --tcp and --raw-tcp somewhere.
• “Other releases” link on main page is broken, needs to point to https://mitmproxy.org/docs/latest/overview-installation/
• Add a max-width to the docs. It is hard to read on 27" screens.
• From https://discourse.mitmproxy.org/t/certificates-quick-setup/890 - Mac OS X link has been archived and is no longer updated by Apple. Maybe this link is a suitable replacement: https://support.apple.com/kb/PH20129?locale=en_US
• From https://github.com/mitmproxy/mitmproxy/issues/2981: Add border mitm.it screenshot to make clear it’s an image.
• https://mitmproxy.org/docs/ needs to go.
• Google Analytics for docs
• Google Analytics for main site
• Addon development docs, mentioning hot reload and testing
• Key binding configuration docs
• Provide an auto-generated man-page like listing of all options, ideally with availability tags for mitmproxy/mitmweb/mitmdump, via a script
• Provide an auto-generated man-page like listing of all commands, ideally with availability tags for mitmproxy/mitmweb/mitmdump, via a script
• make top-left banner src/static/logo-docs.png either high-res (apple 2x style) or an svg vector graphic. Image source at https://github.com/mitmproxy/mitmproxy.org/tree/master/logo (see modd.conf)

To be discussed:

• Have we considered adding a second level navigation as on rtd? https://www-test.mitmproxy.org/docs/latest/overview-features/ seems a bit off, and https://www-test.mitmproxy.org/docs/latest/howto-transparent/ would need one.

[q2dg]

I don’t know if it’s a bit off-topic here, but it’s worthy mentioning script API documentation needs to be done.

[armudgal]

@lacombar Hi, the issue was identified and was rectified in the master branch. The website will be updated soon. Thanks