Add documentation

How to add documentation

We welcome any additions and improvements to the documentation and strongly encourage you to submit any you may have. First let us discuss the types of documentation you can find on this site.

Documentation types

There are two types of documentation:

• APSIM Generated Documentation

  • generated from the APSIM software
  • HTML formatted and includes embedded images and branded styling
  • main consumers are APSIM model developers

• User generated documentation

  • Markdown format
  • custom made by APSIM users and developers
  • main consumers are end-users

Submitting a change

For APSIM models, apsimx files that are tutorials, and for validation files

Submit changes and additions using a pull request to this repo and put the file in an appropriate location under the apsim-docs-html folder.

All other types of documentation aimed at end-users

Submit changes and additions using a pull request to this repo and put the file in an appropriate existing folder under the apsim-docs-md folder. You can also create a new folder if it does not fit into the existing stucture.