Skip to content

DOC:Add a Image Processing Flow diagram and minor fixes #1259

@akshajtiwari

Description

@akshajtiwari

What's wrong with the existing documentation

Improve README with Visual Flow Diagram & Admonition Fixes

What's missing / needs improvement

The current README lacks a clear visual representation of the image processing workflow, making it harder for new contributors to quickly understand the system flow. Additionally, some admonitions (notes/warnings/tips) need consistency and formatting fixes.

Proposed changes

  • Add a visual flow diagram illustrating the end-to-end image processing pipeline
  • Include the diagram under an appropriate section (e.g., Architecture or Workflow)
  • Apply admonition fixes:
    • Standardize formatting (notes, warnings, tips)
    • Improve clarity and consistency across sections
    • Align with markdown/admonition best practices

Why this helps

  • Makes the processing pipeline easier to understand at a glance
  • Improves readability and documentation quality
  • Creates a more polished and contributor-friendly README

Additional context

  • Admonition fixes have already been implemented locally and can be included in this update

Declaration

  • I agree to follow this project's Code of Conduct
  • I want to work on this issue

Video Example

2025-11-26_01-00-42.mp4

Add ScreenShots

No response

Record

  • I agree to follow this project's Code of Conduct
  • I want to work on this issue

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions