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 rdoorn » Wed Jun 13 2018 18:01

https://volumio.github.io/docs/Good_to_Knows/Mounting_an_NFS_Share.html
Like to add
vers=2.0
with the advanced NFS options. Synology now uses newer NFS.
Random avatar
rdoorn
Fresh off the boat
Fresh off the boat
 
Posts: 8
Joined: Wed Jan 10 2018 19:33

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


Documentation Feedback

Postby xlisec » Fri Aug 10 2018 13:28

Hi,

I encounted to missing information in volumio documentation. I want create special configuration to my xiaomi IR remote controll. When you look into current IR configurations (https://github.com/volumio/volumio-plug ... igurations), you will see more powerfull API than it is in documentation (https://volumio.github.io/docs/Good_to_ ... lient.html). Few examples:

(Apple Remote A1156 lircrc)
button = KEY_PLAY
config = /usr/local/bin/volumio toggle

button = KEY_MENU
config = /usr/local/bin/volumio random

(Apple Remote A1294 lircrc)
button = KEY_ENTER
config = /usr/local/bin/volumio volume toggle

(JustBoom IR Remote lircrc)
button = Back
config = /usr/local/bin/volumio repeat

button = Home
config = /usr/local/bin/volumio clear
(this command is perfect example. What is "clear" doing???)

(Arcam ir-DAC-II Remote lircrc)
button = KEY_STOP
config = /usr/local/bin/volumio stop


What is needed?
- Improve documentation on web
- Improve documentation in volumio binary. Result of the command "volumio --help" does not match web documentation nor functionality
- Please If you can, move section Good to Knows->Command_Line_Client into section API->Command_Line_Client. I try read documentation before ask, but place of "Command_Line_Client" is confusing for me. I want control volumio, I search in "API" not in "Good to Knows".
- It is possible update ir_controller plugin for more remote controlls? I see in GIT IR controllers like Apple Remote A1294, Arcam ir-DAC-II Remote, Denon Remote RC-1204, Samsung AA59-00431A, Samsung_BN59-006XXA, XBox One Remote, Yamaha RAV363

Thanks
Random avatar
xlisec
Serious Listener
Serious Listener
 
Posts: 95
Joined: Fri Apr 27 2018 18:59


Documentation Feedback

Postby balbuze » Fri Aug 10 2018 14:11

Hi!
Feel free to send a PR for your remote conf !
We are working to improve the documentation. We agree some part need to be move.
It's not so easy to do that...
But same than for plugin, you can send a PR with what you think/want to see.
Thanks !
User avatar
balbuze
Moderator
 
Posts: 1614
Joined: Thu May 08 2014 08:42
Location: Isère France


Documentation Feedback

Postby xlisec » Fri Aug 10 2018 14:35

I don't know what is PR. Public Relations? :)
Random avatar
xlisec
Serious Listener
Serious Listener
 
Posts: 95
Joined: Fri Apr 27 2018 18:59


Documentation Feedback

Postby balbuze » Fri Aug 10 2018 15:00

Sorry,
a PR is a PULL REQUEST in github...
for the doc contribution, have a look here : https://volumio.github.io/docs/Good_to_Knows/Contribute_to_this_Doc.html

I'm going to move section as you suggested and add some missing configuration keys. ;)
User avatar
balbuze
Moderator
 
Posts: 1614
Joined: Thu May 08 2014 08:42
Location: Isère France


Documentation Feedback

Postby balbuze » Fri Aug 10 2018 15:29

I have updated the doc according to your suggestions. To be finished... ;)
User avatar
balbuze
Moderator
 
Posts: 1614
Joined: Thu May 08 2014 08:42
Location: Isère France


Documentation Feedback

Postby xlisec » Fri Aug 10 2018 18:11

Wow. Thank you for quick improvement. I have account on github but I don't use it. But I will try make my first pull request for my remote controll. It will be nice use my IR controll in UI without setting via SSH.
Random avatar
xlisec
Serious Listener
Serious Listener
 
Posts: 95
Joined: Fri Apr 27 2018 18:59


Documentation Feedback

Postby xlisec » Sun Aug 12 2018 11:56

Hi balbuze , I tried make simple pull request for documentaion. I added toggle options to documentaion. Can you check it?
Random avatar
xlisec
Serious Listener
Serious Listener
 
Posts: 95
Joined: Fri Apr 27 2018 18:59


Documentation Feedback

Postby balbuze » Sun Aug 12 2018 12:23

perfect!
I merged it ;)
User avatar
balbuze
Moderator
 
Posts: 1614
Joined: Thu May 08 2014 08:42
Location: Isère France


Documentation Feedback

Postby xlisec » Mon Aug 13 2018 19:24

I made PR in ir controller plugin yesterday. But I don't have any response. Shall I send to someone message? Balbuze, your merge was quick, but I'm confused now.
Random avatar
xlisec
Serious Listener
Serious Listener
 
Posts: 95
Joined: Fri Apr 27 2018 18:59

PreviousNext

Return to Development talks

Who is online

Users browsing this forum: No registered users and 0 guests