mendhak / waveshare-epaper-display

At-a-glance dashboard for Raspberry Pi with a Waveshare ePaper 7.5 Inch HAT. Date/Time, Weather, Alerts, Google/Outlook Calendar
https://code.mendhak.com/raspberrypi-epaper-dashboard/
438 stars 65 forks source link

Consider creating a mini documentation site #45

Open mendhak opened 1 year ago

mendhak commented 1 year ago

Something to think over. The README.md is growing very large.

Would it be easier for users if the instructions were in a simple documentation site, with each step in its own section and each calendar/weather provider gets its own page, so users can jump between them easily.

I am thinking of using an Eleventy theme called Spacebook. Eleventy is convenient because the content is in Markdown and any customizations are in Javascript and Eleventy just builds the site.

The menu on the left becomes the links to jump between pages. It would require splitting up the README.md's sections. I could link the README.md to the documentation site.

I could also just redirect the blog post... and include its pieces in the documentation site as well. Maybe.

mendhak commented 1 year ago

Dear future me. I think get on that documentation site soon. The README is getting massive, and people will miss steps with so much scrolling.