OpenCMISS / documentation

Documentation used by OpenCMISS website.
http://opencmiss.org/documentation.html
2 stars 9 forks source link

Add tutorials to the website #67

Open PrasadBabarendaGamage opened 7 years ago

PrasadBabarendaGamage commented 7 years ago

This will involve:

  1. Updating the tutorials page of the OpenCMISS website so we can add tutorials related to computation and visualisation (currently there are only visualisation related tutorials)
  2. Move/update the existing python Laplace example tutorial (which introduces OpenCMISS concepts) from the old ABI book readthedocs and add it directly to the readme file of the Laplace example in the OpenCMISS/example repo (similar to what Andre has done with the monodomain example). This would allow us to keep the documentation with the code.
  3. Add/link the documentation for this example as a tutorial on the OpenCMISS website.
  4. Provide template example that includes template source code, tests, documentation.
  5. Add documentation to the developer documentation section of the website to describe how to add documentation to python example files (i.e. explain how we did 2.), so that other developers can document their examples in a similar manner.
  6. Convert existing examples to tutorials in the future to explain OpenCMISS concepts/use as teaching guides for postgraduate students or undergraduate courses.
PrasadBabarendaGamage commented 7 years ago

Hi @inkybutton I was just wondering - if we add a new tutorial to the documentation repo, will it automatically be added to the OpenCMISS website?

inkybutton commented 7 years ago

Hi @PrasadBabarendaGamage, yes. I've checked and there's a webhook set up to notify the builder if a change is made to the documentation repository.

PrasadBabarendaGamage commented 7 years ago

Thanks Noel!