search

sonic-pi-net / sonic-pi

Code. Music. Live.
https://sonic-pi.net
Other
10.75k stars 918 forks source link

[Documentation issue] - Section B.2 Shortcut Cheatsheet #3404

Open 444B opened 3 months ago

444B commented 3 months ago

Hi Team :)

Issue: The app and this repos docs correctly state in Section B.2 of the tutorial to refference Section B.1 for motivation.

However, the live web tutorial shows to reference Section 10.1.
Seen here

This highlights that there are differences between the web documentation and the source and its not clear now different they might be

Expected fix:

  1. Resolve the web version to correctly show B.1 instead of 10.1
  2. Understand why there is a difference and reconcile between the two versions of tutorials

Thanks!

Happy to help out if needed

rbnpi commented 3 months ago

The web based tutorial is for version 3.2 (stated at the end) and is significantly out of date for recent version in various areas. For example Minecraft is no longer supported since version 4.0 of SP. This is because the RPi version was dropped from their OS. (There is a hacked version produced by pi-apps.io which does run on the latest OS but I don't know if it still contains the software necessary to interact with SP were the code there to be reinstated.) There are probably other examples where it is out of date. The builtiin History file and documentation within the SP app should be accurate to get latest info. Basically the web documentation should be brought up to date to version 4.5.1

444B commented 3 months ago

@rbnpi Thanks for the response! Yes, that sounds about right Do you have any information as to how we can update the web based tutorial match the current 4.5.1 ? Where is the source code for the web version hosted?

rbnpi commented 3 months ago

It's pretty easy to do. The documentation is all generated when you build from source as html files. These are located in sonic-pi/app/gui/qt/book folder (you start with Examples.html, Fx.html, Samples.html,Synths.html or Tutorial.html depending on what you want. (There are different language options for Tutorial). It is merely a matter of transferring these to the website. However Sam would have to do that for sonic-pi.net

EDIT you don't have to do a complete build. I think just compiling ruby extensions and then running the pre-translation script for your OS. eg on my Pi I downloaded a new sourcecode for 4.5.1 then RAN server/ruby/bin/compile-extensions.rb (from the app folder) followed by ./linux--pre-translations.sh I did have requisites preinstalled eg ruby

rbnpi commented 3 months ago

@samaaron Any chance of updating the Tutorial on sonic-pi.net to 4.5.1 version. Currently at 3.2