diff --git a/EpiAware/docs/src/index.md b/EpiAware/docs/src/index.md index e69de29bb..a9b7be685 100644 --- a/EpiAware/docs/src/index.md +++ b/EpiAware/docs/src/index.md @@ -0,0 +1,36 @@ +# EpiAware.jl + +*Infectious disease situational awareness modelling toolkit for Julia.* + +A package for building and fitting situational awareness models for infectious diseases. The package is designed to be flexible and extensible, and to provide a consistent interface for fitting and simulating models. + +## Package Features + +- **Flexible**: The package is designed to be flexible and extensible, and to provide a consistent interface for fitting and simulating models. +- **Modular**: The package is designed to be modular, with a clear separation between the model and the data. +- **Extensible**: The package is designed to be extensible, with a clear separation between the model and the data. +- **Consistent**: The package is designed to provide a consistent interface for fitting and simulating models. +- **Efficient**: The package is designed to be efficient, with a clear separation between the model and the data. + +See the [Index](@ref main-index) for the complete list of documented functions and types. + +## Manual Outline + +```@contents +Pages = [ + "man/contributing.md", +] +Depth = 1 +``` + +## Library Outline + +```@contents +Pages = ["lib/public.md", "lib/internals.md"] +``` + +### [Index](@id main-index) + +```@index +Pages = ["lib/public.md"] +``` diff --git a/EpiAware/docs/src/contributing.md b/EpiAware/docs/src/man/contributing.md similarity index 100% rename from EpiAware/docs/src/contributing.md rename to EpiAware/docs/src/man/contributing.md