Useful Links

• Diataxis: Reference for the new documentation framework Sienna is striving to follow (not specific to Julia)

• Julia's guidance on Writing Documentation

• Documenter.jl: Julia's documentation package, the Syntax and Showcase pages are especially useful

  • DocumenterInterLinks.jl: A helper package for making hyperlinks between packages using Documenter.jl's @extref link syntax, without hardcoded urls that can get out of date
  • DocStringExtensions.jl: Another helper package to automate docstrings formatting, including signatures and arguments lists

• SiennaTemplate.jl Git repository: A template for new Sienna packages that includes the required documentation framework.