update developer guide, help

Author: itsdfish

docs/make.jl

@@ -69,6 +69,7 @@ makedocs(
             "Changing the Layout" => "layout.md",
             "Plot Model Process" => "plot_model.md"
         ],
+        "Help and Issues" => "issues.md",
         "Performance Tips" => "performance_tips.md",
         "API" => "api.md",
         "Developer Guide" => "developer_guide.md"

docs/src/developer_guide.md

@@ -1,6 +1,37 @@
+# Contributing
+
+If you are interested in contributing, please open an issue and propose changes or additions you think would be beneficial. After discussion and approval, create a fork of the repository, and submit the changes via a pull request. Please review the guidelines described below.  
+
 # Style Guide
 
-The code written in SequentialSamplingModels.jl follows the guidlines presented in the .[JuliaFormatter.toml](https://github.com/itsdfish/SequentialSamplingModels.jl/blob/master/.JuliaFormatter.toml) file, which is inspired by [blue style](https://github.com/JuliaDiff/BlueStyle). You may run the formatter locally by loading SequentialSamplingModels into your session and running ` JuliaFormatter.format(SequentialSamplingModels)`. All PRs undergo a formatting check, which will provide suggestions if you forget to run the formatter locally.  
+The code written in SequentialSamplingModels.jl follows the guidlines presented in the .[JuliaFormatter.toml](https://github.com/itsdfish/SequentialSamplingModels.jl/blob/master/.JuliaFormatter.toml) file, which is inspired by [blue style](https://github.com/JuliaDiff/BlueStyle). You may run the formatter locally by loading SequentialSamplingModels into your session and running ` JuliaFormatter.format(SequentialSamplingModels)`. All PRs undergo a formatting check, which will provide suggestions if you forget to run the formatter locally. 
+
+# API
+
+In this section, we provide a high-level overview of the API. We recommend reviewing the code for the [Lognormal Race Model](https://github.com/itsdfish/SequentialSamplingModels.jl/blob/master/src/multi_choice_models/LNR.jl) for a simple example illustrating the implementation of a model. 
+
+## Types
+
+The type system current consists of the following abstract model types:
+
+- `SSM1D`: abstract SSM for univariate reaction time distributions
+- `SSM2D`: abstract SSM for joint choice, reaction time distributions
+- `ContinuousMultivariateSSM`: abstract SSM for continuous multivariate distributions
+
+Most models can be implimented as sub-types of one of the three abstract types above. When adding a new model, create a new abstract type so users can develop alternative implementations as needed. 
+
+## Methods 
+
+The following methods are required for each new model. Defining new methods for other functions in the API (e.g., `length`) is typically not required. 
+
+- `increment!`
+- `logpdf`
+- `pdf`
+- `plot_model`
+- `rand`
+- `simulate`
+
+Only export (make public) types and methods that are intended for users. Other methods are implementational details for interal use. 
 
 # Documentation
 
@@ -56,9 +87,6 @@ For the benefit of other developers, err on the side of providing doc strings fo
 
 Provide a detailed model walk through for the online documentation under the section `Models`. The walk through should include a description of the model, an explanation of the model parameters, and a demonstration showing the pdf overlayed on the histogram (if applicable). Please use existing model examples as a template. 
 
-# API
-
-Only export (make public) types and methods that are intended for users. Other methods are implementational details for interal use. 
 
 # Unit Tests
 
@@ -79,6 +107,3 @@ To ensure consistency across models, please use the following variable names:
 
 Use variable names that are descriptive unless there is a strong mathematical convention for a particular variable name. When appropriate, use verbs to describe functions. For example, use `summarize(model)` instead of `summary(model)`. Use lower case for variables, and capitalize the first letter of package names, types, and constructors. Use underscore to separate words. For example, name a file `developer_guide.md` instead of `developerguide.md`.
 
-# Contributing
-
-If you are interested in contributing, please open an issue and propose changes or additions you think would be beneficial. After discussion and approval, create a fork of the repository, and submit the changes via a pull request.  

docs/src/index.md

@@ -70,6 +70,9 @@ logpdf(dist, sim_data)
 histogram(dist)
 plot!(dist; t_range=range(.3,2.5, length=100), xlims=(0, 2.5))
 ```
+# Contributing
+
+If you are interested in contributing, please review the [developer guidelines](developer_guide.md) before beginning. 
 
 # References
 Evans, N. J. & Wagenmakers, E.-J. Evidence accumulation models: Current limitations and future directions. Quantitative Methods for Psychololgy 16, 73–90 (2020).

docs/src/issues.md

@@ -0,0 +1,17 @@
+# Issues
+
+If you encounter a bug or issue, please submit an issue on [GitHub](https://github.com/itsdfish/SequentialSamplingModels.jl/issues). Be sure to include the following details in the issue:
+
+1. A concise description of the problem, including the error message
+2. A minimum working example that demonstrates the issue you encountered.
+3. The version of Julia, SequentialSamplingModels.jl and dependencies you are using
+
+Please use the formatting features for code and error messages. 
+
+# Feature Requests
+
+Open an issue on [GitHub](https://github.com/itsdfish/SequentialSamplingModels.jl/issues) to propose a feature that would be of general interest to the larger modeling community. 
+
+# Help
+
+If you need help, feel free to start a thread on [Discourse](https://discourse.julialang.org/) or the [Discussions](https://github.com/itsdfish/SequentialSamplingModels.jl/discussions) forum for SequentialSamplingModels.jl