JuliaRheology/RheoHelpDocs

Introductory guides to the RHEOS Documentation, Testing and Versioning procedures

RheoHelpDocs

This repository contains documents which introduce the documentation, testing and versioning systems used in RHEOS.

DocumentationGuide.md

Explanation of the documentation system used by RHEOS, how to modify and build documentation locally, and how it is built remotely.

TestingGuide.md

Explanation of the testing framework used by RHEOS. It demonstrates how to add new tests, run tests locally and debug testing failures that occur on the remote servers during the CI stage.

VersioningGuide.md

Explanation of the versioning procedure of RHEOS. Most importantly: how to create a new version of RHEOS, describe its dependencies, and submit to the Julia central package repository.