Buzztouch Documentation - come contribute!

Get Started | Login

Discussion Forums > Buzztouch News and Announcements

Replies: 3 Views: 127

mrDavid BTMods.com Posts: 3936 Reg: May 21, 2011 San Diego, CA 51,910	confirm \| cancel 02/28/14 10:58 AM (10 years ago) Buzztouch Documentation - come contribute! Hi all, BTMods recently released a platform for Documentation for the new 3.0 core. If you would like to contribute, edit, add, in any way shape or form, please register and get going! You'll find more documentation as we.. document it. We're working hard, but help is appreciated. Looking forward to seeing contributions! https://www.btmods.com/docs/ We have a small list of things that need to be documented, so get in touch with me if you're up for the challenge. :) If you have any questions, please get in touch with me on Buzzchat. https://www.btmods.com/chat/ David Title Comments Hi all, BTMods recently released a platform for Documentation for the new 3.0 core. If you would like to contribute, edit, add, in any way shape or form, please register and get going! You'll find more documentation as we.. document it. We're working hard, but help is appreciated. Looking forward to seeing contributions! https://www.btmods.com/docs/ We have a small list of things that need to be documented, so get in touch with me if you're up for the challenge. :) If you have any questions, please get in touch with me on Buzzchat. https://www.btmods.com/chat/ David

AlanMac Aspiring developer Posts: 2612 Reg: Mar 05, 2012 Esher, UK 37,120	02/28/14 11:14 AM (10 years ago) Hi - I'm all for documentation, its a good thing. Bu I just wanted to ask - how do you see this being used in the context of the existing Buzztouch How To's https://www.buzztouch.com/resources/ - isn't that the place where documentation goes? Comments Hi - I'm all for documentation, its a good thing. Bu I just wanted to ask - how do you see this being used in the context of the existing Buzztouch How To's https://www.buzztouch.com/resources/ - isn't that the place where documentation goes?

epicweb Aspiring developer Posts: 159 Reg: Aug 30, 2012 Glen Carbon 4,990	02/28/14 11:32 AM (10 years ago) Buzztouch is very lucky to have customers like you that go way above and beyond. ITs amazing how much time others spend doing some of the things that should already be apart of Buzztouch. With some many changes from 1.5 to 3.0 I'm just surprised that the buzztouch team has not already update this 1.5 information. http://www.buzztouch.com/docs/v1.5/ Comments Buzztouch is very lucky to have customers like you that go way above and beyond. ITs amazing how much time others spend doing some of the things that should already be apart of Buzztouch. With some many changes from 1.5 to 3.0 I'm just surprised that the buzztouch team has not already update this 1.5 information. http://www.buzztouch.com/docs/v1.5/

mrDavid BTMods.com Posts: 3936 Reg: May 21, 2011 San Diego, CA 51,910	02/28/14 11:41 AM (10 years ago) Hi Alan! Great question, how-to's and documentation are very two different beasts. Take a look at what EpicWeb just posted (his link to the old 1.5 documentation). That's what we're doing with 3.0 (but even further than that). Instead of creating a guide to "how to do this" we're creating documentation that "how this works", functions, variables, placeholders, explaining the code and how everything functions. If you wanted to explicitly know what's going on in your JSON or a certain file, how it functions, and so on, you check Documentation. If you want to learn how to integrate Scringo in your app, you go to How-To's. Take for example, your building a plugin, and you need to use color, you can find documentation regarding BT_Color.m and what that code offers for plugin developers to access. It tells you all about that file as it's been "documented" and it potentially (or will) save you hours of time. Example: https://www.btmods.com/docs/buzz.php?id=buzztouch_v3:01_database_structure Hope that helps a bit. :-) Cheers! David https://btmods.com/chat/ Comments Hi Alan! Great question, how-to's and documentation are very two different beasts. Take a look at what EpicWeb just posted (his link to the old 1.5 documentation). That's what we're doing with 3.0 (but even further than that). Instead of creating a guide to "how to do this" we're creating documentation that "how this works", functions, variables, placeholders, explaining the code and how everything functions. If you wanted to explicitly know what's going on in your JSON or a certain file, how it functions, and so on, you check Documentation. If you want to learn how to integrate Scringo in your app, you go to How-To's. Take for example, your building a plugin, and you need to use color, you can find documentation regarding BT_Color.m and what that code offers for plugin developers to access. It tells you all about that file as it's been "documented" and it potentially (or will) save you hours of time. Example: https://www.btmods.com/docs/buzz.php?id=buzztouch_v3:01_database_structure Hope that helps a bit. :-) Cheers! David https://btmods.com/chat/

Login + Screen Name Required to Post Login to participate so you can start earning points. Once you're logged in (and have a screen name entered in your profile), you can subscribe to topics, follow users, and start learning how to make apps like the pros.