Documentation Feedback

Discuss, contribute and orient Volumio development!

Ads helps Volumio remain Free and Open Source. Please consider donating to help us continue to serve you.

Documentation Feedback

Postby pintea » Tue Apr 18 2017 20:13

Has the official documentation (http://docs.volumio.org) betrayed you when you most needed it? Let us know here.

Please describe where you think the docs could/should be more detailed, we'll do our best to improve them!

Alternatively you could go ahead and change them yourself here https://github.com/volumio/docs!
Contributing to the docs is explained more in detail here https://volumio.github.io/docs/Good_to_Knows/Contribute_to_this_Doc.html.
Cris Pintea http://pintea.net

If you appreciate my work buy me a coffee!

That's very appreciated!
User avatar
pintea
Moderator
 
Posts: 47
Joined: Fri Apr 14 2017 22:54
Location: Turin, Italy

Ads helps Volumio remain Free and Open Source. Please consider donating to help us continue to serve you.


Documentation Feedback

Postby sla89 » Mon Apr 24 2017 18:34

Personally I don't like the structure of the section 'Plugin System'.

The part about the index.js is too big. You get lost so easily when you are reading it. I would prefer to split it up into several parts.
Random avatar
sla89
Sunday DIYer
Sunday DIYer
 
Posts: 48
Joined: Sun Feb 26 2017 18:42


Documentation Feedback

Postby michelangelo » Mon Apr 24 2017 18:52

If you want to split, this might be a good idea. Since I just merged your PR, feel free to make further adjustments!
User avatar
michelangelo
Founder
 
Posts: 4095
Joined: Sun Dec 15 2013 23:18


Documentation Feedback

Postby sla89 » Mon Jun 05 2017 09:11

I have started with my docu updates and created a PR. :)

Further suggestions will follow.
Random avatar
sla89
Sunday DIYer
Sunday DIYer
 
Posts: 48
Joined: Sun Feb 26 2017 18:42


Documentation Feedback

Postby michelangelo » Mon Jun 05 2017 11:51

Merged, thanks!
User avatar
michelangelo
Founder
 
Posts: 4095
Joined: Sun Dec 15 2013 23:18


Documentation Feedback

Postby reveur » Mon Jan 22 2018 08:43

Wow that was the music system I was dreaming about since a while!!

Took me a few hours to make it work though. Two things that could be added to the documentation that would have helped:

1. Tracks are not scanned from a USB flash drive if its filesystem is ext4 (although we can see them from a ssh session). I don't know if that's a bug or it just hasn't been implemented yet, but in any case that would have been helpful to know.

2. If files are copied directly to the SD card from a ext4 filesystem (for example the aforementioned USB flash drive), insufficient access rights may prevent the tracks from being scanned (in which case changing them to 777 solve the problem).

Thanks!
Random avatar
reveur
Fresh off the boat
Fresh off the boat
 
Posts: 1
Joined: Mon Jan 22 2018 08:17


Documentation Feedback

Postby chsims1 » Mon Jan 22 2018 12:12

Just in the process of adding some FAQs to the documentation. If there was one FAQ that you (the Community) would have wished for when first installing Volumio, what would it be? Feel free to contribute more than one ;)
New to Volumio? Please read the Quick Start Guide to get your system up and running :). FAQs? PM me if you want one adding.
User avatar
chsims1
Moderator
 
Posts: 1728
Joined: Sat Aug 02 2014 10:44
Location: East Yorkshire, UK


Documentation Feedback

Postby autur » Tue Mar 13 2018 21:01

Please add additional instructions on how/where to login to SSH and a bit of info on what SSH is. Like many new users, I have no prior knowledge of Linux/Pi. This documentation only provides the login details, assuming that everyone knows what SSH is. https://volumio.github.io/docs/User_Manual/SSH.html
Random avatar
autur
Fresh off the boat
Fresh off the boat
 
Posts: 4
Joined: Fri Dec 22 2017 07:16


Documentation Feedback

Postby gwinkler » Tue Apr 10 2018 14:08

Hi there,

It seems that the System Architecture illustration image on this page is not available anymore or has been moved !
https://volumio.github.io/docs/Developm ... cture.html
User avatar
gwinkler
Fresh off the boat
Fresh off the boat
 
Posts: 1
Joined: Tue Apr 10 2018 14:04


Documentation Feedback

Postby pintea » Tue May 01 2018 19:28

You're right! I was actually looking for it some days ago and I thought I was crazy and probably just dreamed it up ever being there, well guess I'm not so crazy after all! Will see if someone can reupload it.
Cris Pintea http://pintea.net

If you appreciate my work buy me a coffee!

That's very appreciated!
User avatar
pintea
Moderator
 
Posts: 47
Joined: Fri Apr 14 2017 22:54
Location: Turin, Italy

Next

Return to Development talks

Who is online

Users browsing this forum: No registered users and 0 guests