OpenScan-org / OpenScan2

an improved firmware for the OpenScan devices, featuring many more cameras and a greatly improved overall usability
GNU General Public License v3.0
254 stars 29 forks source link

Use mkdocs for project documentation #50

Closed Polectron closed 2 years ago

Polectron commented 2 years ago

MkDocs allows writing documentation in Markdown with a modern look, and helps in making it organized and easily navigable. Live example: https://polectron.github.io/OpenScan2/ image

OpenScanEu commented 2 years ago

Thank you so much. These are great improvements! :)))

Polectron commented 2 years ago

Awesome! It's possible that you need to enable github pages and rerun the github action for it to start working though. Btw, I'd love to start working more closely on cleaning and refactoring some of the code, is there a way to keep direct contact with you to discuss some ideas?

OpenScanEu commented 2 years ago

@Polectron This sounds absolutely great! I haven't had a lot of time over the past few months, but I finally managed to create a dedicated Discord server for the future developments of the project: https://discord.gg/MhWfrjnP This is still an early stage of a more-collaborative environment, so any input is highly appreciated...