Complete Basic Requirements Checklist

Sienna packages should follow the Diataxis framework, be strictly compiled with Documenter.jl v1.0 or greater, and be automatically formatted with JuliaFormatter.jl.

For New Packages

The SiennaTemplate.jl Git repo has the required environments and formatting and documentation code. Start from this template.

For Existing Packages

Existing Sienna packages will need to be updated with these requirements, but these will only need to be addressed once:

1. Organize the top-level documentation to follow the Diataxis framework (plus a welcome page/section). This might be a significant undertaking. See:

   • How to Write a How-to Guide
   • How to Write a Tutorial
   • How to Organize APIs and Write Docstrings

2. Update the Project.toml file in the docs/ folder to replace compat requirements of Documenter = "0.27" with Documenter = "1.0"

3. Update the docs/make.jl file to call Documenter.makedocs without the warnonly kwarg (i.e., all errors caught by makedocs must be resolved before merging). See an example here.

   • See How-to Troubleshoot Common Errors if this results in a host of errors.

4. Update the scripts/formatter/formatter_code.jl to format the markdown .md files in the docs/ folder, calling format() with the kwarg format_markdown = true. See these three links for examples of the updated lines.