Yamato-Security / hayabusa

Hayabusa (隼) is a sigma-based threat hunting and fast forensics timeline generator for Windows event logs.
GNU General Public License v3.0
2.17k stars 189 forks source link

Create GitHub Pages Documentation #843

Open YamatoSecurity opened 1 year ago

YamatoSecurity commented 1 year ago

I am currently thinking of doing this with Material for MkDocs: https://squidfunk.github.io/mkdocs-material/ Something similar to this: https://www.purplecloud.network/install/

hitenkoku commented 1 year ago

If you want to provide documentation for each version, readthedocs may be a good option.

https://docs.readthedocs.io/en/stable/tutorial/

Or have the mkdocs page refer to the documentation as "previous versions" (complicated)?

YamatoSecurity commented 1 year ago

Thanks for the links! I think as long as we have version history to go back to a previous version if needed, it should be fine. I'm guessing people won't need to use old versions of hayabusa so shouldn't need old documentation.