search

MiczFlor / RPi-Jukebox-RFID

A Raspberry Pi jukebox, playing local music, podcasts, web radio and streams triggered by RFID cards, web app or home automation. All plug and play via USB. GPIO scripts available.
http://phoniebox.de
MIT License
1.3k stars 394 forks source link

🚀 | Add user guide for V3 #2383

Open s-martin opened 1 month ago

s-martin commented 1 month ago

Feature

The new future3 implementation lacks a user guide at this point.

for V2 there exists a manual in the wiki: https://github.com/MiczFlor/RPi-Jukebox-RFID/wiki/MANUAL

For future3 / V3 something similar should be written although it should be in the documentation folder as markdown file(s).

plimptm commented 1 week ago

I'm willing to help with v3 documentation based on my experience as a new comer to the project. Is there a working space (beyond this issue thread) where efforts can be coordinated? Anything of higher priority?

s-martin commented 6 days ago

Help is always welcome.

Currently there is now workspace started yet, I suggest to open a new branch (and draft PR), where development can take place and we discuss implementation.

I would start the userguide with explaining how to use the web app and its features (screenshots should help). I would implement it similar to the V2 user guide

We want to implement all the docs as markdown located in ./documentation. See the hints how to use markdown. Do not implement it in the wiki.

Please also use the chat https://matrix.to/#/%23phoniebox_community%3Amatrix.org if required.