Skip to content

Update README.md to include an image - #416

Open
emmanucheru-sudo wants to merge 1 commit into
cloudflare:mainfrom
emmanucheru-sudo:patch-1
Open

Update README.md to include an image#416
emmanucheru-sudo wants to merge 1 commit into
cloudflare:mainfrom
emmanucheru-sudo:patch-1

Conversation

@emmanucheru-sudo

Copy link
Copy Markdown

Added an image to enhance the README documentation.

Added an image to enhance the README documentation.

@emmanucheru-sudo emmanucheru-sudo left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

emmanucheru-sudo:patch-1

@emmanucheru-sudo emmanucheru-sudo left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update README.md to include image

@emmanucheru-sudo emmanucheru-sudo left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this matters

The current change embeds raw HTML <img> tags directly inside the text, splitting the word "Workers" across two lines. This breaks:

  1. Readability — the text no longer makes grammatical sense when parsed
  2. Accessibility — screen readers encounter "W[image]orkers" instead of "Workers"
  3. Markdown standards — GitHub's semantic image syntax (![alt](url)) is cleaner and more portable

The PR is currently blocked (mergeable_state: "blocked") specifically because of this formatting issue. The fix is simple and maintains the intent of adding visual documentation without breaking the prose.

@emmanucheru-sudo emmanucheru-sudo left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Recommended fix:

It integrates tools powered by [Workers Observability](https://developers.cloudflare.com/workers/observability/) to debug
and get insight into your Workers' logs and analytics.

![Workers Observability Demo](https://github.com/user-attachments/assets/9a0cb856-91a6-4e59-ab75-fbec154c5346)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant