Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🚀 | Add user guide for V3 #2383

Open
s-martin opened this issue Jun 4, 2024 · 2 comments
Open

🚀 | Add user guide for V3 #2383

s-martin opened this issue Jun 4, 2024 · 2 comments
Labels
enhancement future3 Relates to future3 development help wanted

Comments

@s-martin
Copy link
Collaborator

s-martin commented Jun 4, 2024

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).

@s-martin s-martin added enhancement future3 Relates to future3 development help wanted labels Jun 4, 2024
@plimptm
Copy link

plimptm commented Jun 28, 2024

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
Copy link
Collaborator Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement future3 Relates to future3 development help wanted
Projects
None yet
Development

No branches or pull requests

2 participants