-
Notifications
You must be signed in to change notification settings - Fork 8
Project Documentation
Documentation related to a project should be stored according to it's type:
Information related to running a project should be stored in a wiki related to the project management tool (e.g. plan.io).
The architecture and details about the innards of the project should be written up in the Github wiki for the project.
The wiki can be easily edited on the github website, but there is no ability to upload images. However, the wiki can also be [edited on your local machine](Editing the wiki on your local machine), and from there it is easy to add images.
In general though, it's best to update the wiki directly at github.com.
Descriptions of widgets, XDS inputs and outputs, and protocols for RESTful interfaces should be documented as Github Pages. We would prefer to use the normal project wiki, however Github wikis don't permit wii pages to be placed inside an iframe. We'd like this documentation to be able to accessed from within ToolTwist Designer and other places. See Setting up Github Pages for details.
Meta-data to describe widgets as XDS services should be maintained in the normal project repository (alongside the source) in a directory named store.