Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Improving documentation #1315

Closed
10 tasks
federico-pepe opened this issue Jul 2, 2016 · 1 comment
Closed
10 tasks

Improving documentation #1315

federico-pepe opened this issue Jul 2, 2016 · 1 comment

Comments

@federico-pepe
Copy link
Contributor

  • Documentation should be fully accessible on the website with sound examples
  • Revise the whole documentation to avoid repetitions and holes
  • Create a reference organised by categories and move it on the website as well
  • Create a Getting Started guide
  • Separate the Mag Pi articles from the main tutorials
  • I would suggest to stop referring to the Raspberry Pi in the tutorial to avoid confusion because some people - myself included - run Sonic Pi on Mac, PC or Linux
  • Create translations guidelines, I believe that function's name should be translated
  • Create a glossary
  • Move Minecraft's articles into a new section
  • Video Tutorial
@samaaron
Copy link
Collaborator

samaaron commented Jul 2, 2016

Thanks for these suggestions. I think these are better placed in a wiki page so they can be discussed. For example, item 2 would be better expanded with a list of the holes you observe. Also, translating function names isn't something we intend to do - but it would be good to have a page explaining our rationale for that decision.

@samaaron samaaron closed this as completed Jul 2, 2016
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants