# docs(readme): revamp structure, add Quick Start, and include Mermaid diagrams

[Samanyu-dev]

Description

This PR significantly enhances the project's documentation to improve user onboarding and provide a more premium, structured reading experience.

Key changes:

• Added a high-visibility Quick Start section immediately following the introduction (Fixes [Documentation] Add "Quick Start" section to README #9).
• Introduced Mermaid diagrams to visually map out the System Architecture and the Core Leak Detection workflow.
• Restructured content into logical sections (Features, Core Workflows, Developer Commands) with emoji headers for better scannability.
• Fixed various minor grammar/hyphenation issues throughout the text for a cleaner read.

Type of change

• Bug fix (non breaking change which fixes an issue)
• New feature (non breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation update
• Chore / Refactor

Related issues

• Issue: [Documentation] Add "Quick Start" section to README #9
• Related PRs:

How Has This Been Tested

• Manual steps: Rendered the markdown locally to ensure all Mermaid graphs (graph TD and sequenceDiagram) generate correctly and that image asset links are preserved and properly sized.
• Platform tested on: macOS / Web Browser Markdown Preview

Checklist

• I have read the CONTRIBUTING.md and followed the repo guidelines.
• Code builds locally (cargo build --release)
• All tests pass (cargo test)
• New and existing tests cover my changes
• I added/updated documentation where applicable
• I updated CHANGELOG or release notes if needed

CI and Performance Notes

• CI status: CI will pass seamlessly (this is a markdown only change).
• Performance impact: None.

Screenshots or Logs

N/A - See the rendered README.md directly in the PR diff for the visual improvements.

Release Notes

• Release type: patch
• Notes for release manager: The README.md has been overhauled with a new Quick Start guide and architecture diagrams to improve onboarding.