Docs for Paxcounter project

[t-huyeng]

I am working on some docs or lets say more on teleporting the current readme into a nice looking webpage.

See working branch: https://github.com/t-huyeng/ESP32-Paxcounter/tree/mkdocs
See current Webpage: https://t-huyeng.github.io/ESP32-Paxcounter/

I am using Mkdocs Material and a GitHub Workflow to publish the files to a separate branch (gh-pages) which is then used for GitHub-Pages.

Would love to here some thoughts about that!

Todos

• add/create logo
• add examples for custom sensors etc. (see Generic Temperature and Humidty PayloadConvert functions #917)
• add more "real" code snippets (see external files) see: https://t-huyeng.github.io/ESP32-Paxcounter/getting-started/
• favicon
• Update Readme to link to docs and contain all needed Information.
• Link Readme to first Page of Docs

[t-huyeng]

First quick draft of a possible logo (included of the header in the docs):

[cyberman54]

I am going to change the QR code displaying the DEV EUI with the logo. Because scanning the QR from the multiplexed display doesn't work well. So let's display the logo instead.

[cyberman54]

Maybe we need a logo with bold structures for this, to get this converted to pixel matrix.

[t-huyeng]

Good point with the display! Here is the SVG :

More bold will probably be mean the / will not be really visible, but I will check what I can do with my limited inkscape skills ;)

[cyberman54]

We need .BMP, either for monochrome, as well for color displays.

[t-huyeng]

See : https://github.com/t-huyeng/ESP32-Paxcounter/tree/mkdocs/docs/assets for bmp files.

[t-huyeng]

Are you generally up to mkdocs or is this not wanted for this project?

[cyberman54]

I don't know anything on it yet. Don't see a problem, if there is no licence issue.

[t-huyeng]

Licence should not be a problem (MIT) and build for opensource projects like this one here.

[cyberman54]

I am working on some docs or lets say more on teleporting the current readme into a nice looking webpage.

That would be a very useful add on, since documentation for this project has grown step-by-step, and thus is hard to read for new users. Thank you for putting effort on this!

[t-huyeng]

Perfect!
I updated a few parts of the docs and added more code snippets with using the "real" files.
I will try to resolve a few Todes soon, maybe update some images and then create a PR. If you have any suggestions let me know!

See: https://t-huyeng.github.io/ESP32-Paxcounter/ for the current status.

[t-huyeng]

see #919 for further updates.