Help with the manual, take 2

More
26 Jun 2015 09:39 - 26 Jun 2015 09:40 #34672 by mwm
Help with the manual, take 2 was created by mwm
Seems like last time I made this request, I had missed a step in getting the manual updated. So this time, I made sure the built versions in the links on the left have my changes.

If you now follow the links under "User Manual" in the menu, you'll find there's a bunch of new protocols. I made sure that there's an entry for every protocol in the current build, and populated it as best I could from the sources, commit logs, and supported models (also in the menu) spreadsheet. however, we have a lot of protocols I'm not familiar with, and aren't in the supported models spreadsheet.

First request: if you've tested a model with a protocol and it works, please edit the supported models spreadsheet. It is publicly editable. Even if you don't, follow the comments below about changes to the manual.

Second request: If you use a protocol regularly - or developed it - check the entry for it in either manual for completeness and accuracy. If you feel it's lacking in some way - either wrong, or missing critical data, or just needs improvement - please do one of the following things. In order of increasing difficulty and likelyhood of inclusion.

1) Post a note here pointing out which protocol needs changing, and the suggested text of the change. New tested models, etc.

2) Create an issue in the bug tracker in the main menu with that information in it.

3) Clone the manual repository , edit the sources and create a pull request with the changes in it.

Of course, the same process can be followed with any suggested change to the manual, not just fixing the protocols!

Do not ask me questions via PM. Ask in the forums, where I'll answer if I can.

My remotely piloted vehicle ("drone") is a yacht.
Last edit: 26 Jun 2015 09:40 by mwm.

Please Log in or Create an account to join the conversation.

More
27 Jun 2015 15:23 - 27 Jun 2015 15:23 #34751 by Deal57
Replied by Deal57 on topic Help with the manual, take 2
Do you have a deadline for these replies? I am traveling and can't contribute until I return next week.

Thanks for the excellent work you and all the contributors have been doing! Devo Rocks!

Deviation Devo7e 3way switch mod, A7105, NRF24L01
Devo6s 2x2 switch mod, trim mod, haptic, multimodule, A7105, NRF24L01, CC2500
Devo12e 4-in-1 with voice mod -- it speaks!!
Last edit: 27 Jun 2015 15:23 by Deal57. Reason: Grammar...

Please Log in or Create an account to join the conversation.

More
27 Jun 2015 15:24 #34752 by mwm
Replied by mwm on topic Help with the manual, take 2
No deadline. Improvements are always welcome!

Do not ask me questions via PM. Ask in the forums, where I'll answer if I can.

My remotely piloted vehicle ("drone") is a yacht.

Please Log in or Create an account to join the conversation.

More
27 Jun 2015 16:04 #34756 by PhracturedBlue
Replied by PhracturedBlue on topic Help with the manual, take 2
The supported models spreadsheet is not freely editable. Only certain users have edit permissions, but there are quite a few of them. So you should post requested updates here (or in the bug tracker)

Please Log in or Create an account to join the conversation.

More
28 Jun 2015 21:36 #34810 by greenfly
Replied by greenfly on topic Help with the manual, take 2

PhracturedBlue wrote: So you should post requested updates here (or in the bug tracker)

I think the Syma X11C (camera version) should be added. I know that the X11 is listed and compatible, but I think we should be explicit to avoid a future question about it.

Please Log in or Create an account to join the conversation.

More
28 Jun 2015 22:14 #34813 by mwm
Replied by mwm on topic Help with the manual, take 2
Given that we've had vendors change protocols on a model without bothering to change anything else, I can see adding something about the X11C. But if the only thing that's going to change between that and the X11C line is the model name, I feel that's overkill. So I added a note to the X11 entry that it included the X11C.

If you feel like there's more information that needs to be in that entry, could you provide the complete entry?

Do not ask me questions via PM. Ask in the forums, where I'll answer if I can.

My remotely piloted vehicle ("drone") is a yacht.

Please Log in or Create an account to join the conversation.

More
29 Jun 2015 00:24 #34814 by greenfly
Replied by greenfly on topic Help with the manual, take 2
No, a note will do. And the entry seems complete as it needs to be.

I guess I thought there might be some value with knowing the total number of models that Deviation supports. You know as a marketing point. I know we also list models we do not support and that's good to know. Maybe we could move the unsupported to another tab? I don't know... just thinking off the top of my head.

Please Log in or Create an account to join the conversation.

Time to create page: 0.043 seconds
Powered by Kunena Forum