Skip to content

Documentation Guidelines

Guidelines for writing documentation for the Sunny Calculator Add-On.

Documentation

  • Documentation language is english
  • The sidebar will be extended automatically when new pages are added in the existing folders
  • See Starlight: Frontmatter Reference for configuration options for the sidebar label

Diagrams

  • Use Mermaid Diagrams for visualizations wherever possible
  • If not possible use images or svg and reference the source

Decisions

  • To add a decision, duplicate docs/src/content/docs/decisions/_000-template.md and rename accordingly