Details
-
Story
-
Resolution: Fixed
-
High
-
None
-
None
-
None
Description
In order to facilitates updates and additions to the Tweet FieldType tutorial, it should be converted to markdown, and added to the FieldType's repository. It will allow any code contributor to update the content when submitting changes, as we need a perfect synchronization between the code and the text.
Location in the repository
I suggest docs/tutorial, based on php-pds/skeleton, with one file per chapter.
About the Confluence version
Until markdown based documentation is implemented for tech doc in general, we can either link to https://github.com/ezsystems/TweetFieldTypeTutorial/tree/master/docs/tutorial (and rely on github's rendering), or synchronize the Confluence version based on the updated HTML / markdown from github.