Skip to content

Style Guides Directory

Documentation style guides and conventions for consistent documentation

Purpose

This directory contains style guides that define standards and conventions for creating consistent, high-quality documentation across the Home Security Intelligence project.

Key Files

File Purpose
diagrams.md Mermaid diagram standards, themes, and best practices
Document Location Purpose
Visual Style Guide docs/images/style-guide.md Colors, shapes, and design principles for images
Documentation Standards docs/architecture/STANDARDS.md Code citations and document structure
Contributing Guide docs/development/contributing.md PR process and code standards

Entry Points

  • Creating diagrams: Start with diagrams.md for Mermaid conventions and reusable themes
  • Visual assets: See docs/images/style-guide.md for image generation and styling
  • Document structure: See docs/architecture/STANDARDS.md for required sections