search

NSPManager / NSPanelManager

Sonoff NSPanel custom firmware for responsive and intuitive use
https://discord.gg/RwXvAH56fE
178 stars 13 forks source link

Migrate doc from PDF to github pages #207

Open sebastienvermeille opened 1 day ago

sebastienvermeille commented 1 day ago

Is your feature request related to a problem? Please describe. Having to download the PDF doc each time I am willing to learn something about the project is a pain. Also the edition of manual.tex is not straightforward, it require to regenerate the PDF etc.

Describe the solution you'd like I would like to host the documentation as a web documentation using Docusaurus and host it GitHub pages (free).

Describe alternatives you've considered I tried a couple of other frameworks in the past such as Jekyll, docs.page.

While it would also work, Docusaurus is pretty straight forward, actively maintained and provide nice feature such as Search integration, PDF export.

Additional context

This has been validated on Discord while having a discussion with the Founders :+1:

I will open a PR for this issue.

tpanajott commented 1 day ago

Hey, nice work with the docs. A really big uplift from what there is currently. I'm just thinking though, currently there is basically two versions of the PDF. One, that is available for the stable/main branch and one that is for the beta software. Is there a way we can somehow mark certain things in the docs so that users are aware that they are currently only available in the beta version?