search

monome / teletype

monome eurorack module
GNU General Public License v2.0
195 stars 82 forks source link

Remove OP docs and help screen #51

Closed samdoshi closed 6 years ago

samdoshi commented 7 years ago

Do we want to remove the .doc field from ops and mods? The data is currently unused.

Same thing goes for the help text under the F1 key.

With my new found skills I can tell you it will save about 6kb of ROM space. But more importantly, there are currently 3 copies of the teletype docs, the website, the PDFs, and the source code. I think that's too many to try and keep up to date.

I was thinking we could use the F1 - F10 keys as script triggers. Maybe with a modifier to take you to the edit page for the script.

scanner-darkly commented 7 years ago

agreed .doc could be removed, i don't see it being used anywhere. not sure if @tehn had plans for it?

i do find the help screen useful though but i also like the idea of using F keys as script shortcuts (with potentially more modifiers added later, like CTRL to copy, SHIFT to paste), so perhaps a different button could be assigned to it?

re: docs - should we revisit the idea of annotating in the source code and then using something like Doxygen to generate whatever content is needed? i haven't used Doxygen and did a quick search for simpler alternatives, there is https://github.com/libgit2/docurium and http://jessevdk.github.io/cldoc/gettingstarted.html but doesn't look like they would work well in this case. any concerns with using Doxygen?

tehn commented 7 years ago

i'm good to remove the .doc

On Fri, Oct 14, 2016 at 12:54 PM, scanner-darkly notifications@github.com wrote:

agreed .doc could be removed, i don't see it being used anywhere. not sure if @tehn https://github.com/tehn had plans for it?

i do find the help screen useful though but i also like the idea of using F keys as script shortcuts (with potentially more modifiers added later, like CTRL to copy, SHIFT to paste), so perhaps a different button could be assigned to it?

re: docs - should we revisit the idea of annotating in the source code and then using something like Doxygen to generate whatever content is needed? i haven't used Doxygen and did a quick search for simpler alternatives, there is https://github.com/libgit2/docurium and http://jessevdk.github.io/ cldoc/gettingstarted.html but doesn't look like they would work well in this case. any concerns with using Doxygen?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/monome/teletype/issues/51#issuecomment-253858085, or mute the thread https://github.com/notifications/unsubscribe-auth/AAPEcBsBeoXEYHZd4gbEOSrNOvcCpE2eks5qz7PCgaJpZM4KXC-O .

tehn commented 7 years ago

script triggers already assigned to meta-# i think?

On Fri, Oct 14, 2016 at 10:05 AM, Sam Doshi notifications@github.com wrote:

Do we want to remove the .doc field from ops and mods? The data is currently unused.

Same thing goes for the help text under the F1 key.

There are currently 3 copies of the teletype docs, the website, the PDFs, and the source code. I think that's too many to try and keep up to date.

I was thinking we could use the F1 - F10 keys as script triggers. Maybe with a modifier to take you to the edit page for the script.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/monome/teletype/issues/51, or mute the thread https://github.com/notifications/unsubscribe-auth/AAPEcFdfY3SFwI17niGO9yymrc4QqDjLks5qz4wXgaJpZM4KXC-O .

tehn commented 7 years ago

(sorry for the multiple replies.)

jump-to-edit-page is a great idea.

On Fri, Oct 14, 2016 at 10:05 AM, Sam Doshi notifications@github.com wrote:

Do we want to remove the .doc field from ops and mods? The data is currently unused.

Same thing goes for the help text under the F1 key.

There are currently 3 copies of the teletype docs, the website, the PDFs, and the source code. I think that's too many to try and keep up to date.

I was thinking we could use the F1 - F10 keys as script triggers. Maybe with a modifier to take you to the edit page for the script.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/monome/teletype/issues/51, or mute the thread https://github.com/notifications/unsubscribe-auth/AAPEcFdfY3SFwI17niGO9yymrc4QqDjLks5qz4wXgaJpZM4KXC-O .

samdoshi commented 7 years ago

PR in for .doc removal.

@scanner-darkly what do you find useful on the F1 screen? The keys reference, the ops reference, or is it both.

Regarding Doxygen, what's your anticipated use? Developer docs or user docs?

scanner-darkly commented 7 years ago

mostly the ops. but it's just so handy to have a quick ref right there in the module itself.

doxygen - i think the benefit would be to do both, otherwise it's just one more thing to maintain. if it's possible to configure it to output for multiple formats that would mean it only needs to be maintained in one place. i need to read up on it.

samdoshi commented 7 years ago

Fixed in #73

burnsauce commented 6 years ago

Fixed?

burnsauce commented 6 years ago

help_mode.c still exists and its keystrokes are still documented in modes.md. Is this functionality dead? Can it be culled?

samdoshi commented 6 years ago

help_mode.c still exists and its keystrokes are still documented in modes.md. Is this functionality dead? Can it be culled?

Enough people found it useful that it was decided to keep it. It still works, but the key binding is alt-?