Touch Develop retirement postponed until June 22, 2019. Sign-in and access to cloud assets to be removed on May 23, 2018.Learn More..


add your own docs

Users are welcome and encouraged to contribute to the documentation. Whether it is a tutorial or examples for APIs, any user can contribute to help others.

benefits

  • interactive: you can create intelligent step-by-step tutorials
  • integrated: people can follow step-by-step tutorials directly in the editor
  • searchable: the docs are searchable in the app
  • rich editing experience: no more screenshots or pasted snippets, the integrated documentation allows you to author rich text and code in the same editor. Oh, and snippets can be copy-pasted by the reader!
  • consistent rendering: the docs are rendered using the same rendering engine as the editor. They will look and feel like the real thing.
  • printing: the docs can easily be printed by rendering them to flat HTML
  • translation: the docs can be automatically be translated from the editor using Microsoft Translator
  • community: readers can give hearts, post comments or even annotate your topics with further examples.
This feature is available right now in the TouchDevelop Web App. The native Windows Phone app will be updated to match the Web App in the near future.

scripts as documentation

Documentation pages are authored just like regular scripts. To let us know that a script is really documentation add #docs hash tag in the script comments section (tap on the script name in the script editor to access it; you can set the name, icon and color of the tutorial there as well).
  • add #docs to turn a script into a documentation page
  • add #tutorial to make it easy for people to find step-by-step tutorials
  • if you're creating a series of tutorials invent a hash tag of your own
  • add #de to say the documentation is in German, #fr for French, #pl for Polish etc.
Each TouchDevelop API or language construct has an associated tag. To discover what it is, navigate to help topic in question and use the create docs button. You can edit list of hash tags in the comments section as usual. For example, for API names mangle the kind and action name together and remove the spaces: for string→split, add #StringSplit

hearts and comments

Similarly to scripts, each topic may have comments or hearts. The more hearts the higher the topic will show in the lists and searches.
If you cannot write a comment or give a heart, it means there is not much documentation yet for this topic from the TouchDevelop team. Use the I need more docs button to request some. You can also write your own documentation using the create docs button.

authoring the text

The topics are authored as script in the TouchDevelop editor. They can be a combination of formatted comments, code and pictures.
Comments support a simple wiki-like syntax documented here. For example, **bold** gets rendered as bold.
Code can be added as usual through the editor, either as interleaved statements
var x := 0
or entire actions as well
private function
another action
()
you can embed others actions as well...
end function
The text of your tutorial can be spread among any number of actions with names starting with example. If no such actions are found, the main action of the script is used instead.

step-by-step tutorials

Step-by-step tutorials drive users through the process of writing an app. The engine helps and rewards the user along the way. Learn more about creating interactive tutorials.

previewing the docs

As soon as a #docs hash tag is added to the script comment, TouchDevelop will enable a preview button under the script name in the script editor that you can use to see the final rendering of your topic.