Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance Documentation on Theme-Specific Image Display with Illustration and <img> Tag Clarification #34694

Closed
1 task done
syed-ateeb-naveed opened this issue Sep 23, 2024 · 2 comments
Labels
content This issue or pull request belongs to the Docs Content team get started Content related to "Getting Started" doc set

Comments

@syed-ateeb-naveed
Copy link

Code of Conduct

What article on docs.github.com is affected?

Article Affected

Basic writing and formatting syntax

Section Affected

Specifying the theme an image is shown to

Issue Description

The current section lacks an illustration of the image behaviour based on the theme, and the purpose of the <img> tag is not clearly defined. These additions would improve understanding and clarity for readers.

Screenshot Of The Section

image

What part(s) of the article would you like to see updated?

What part(s) of the article would you like to see updated?

The section titled “Specifying the theme an image is shown to” should be updated. Specifically:

  1. Add an Illustration: Include images to demonstrate how the sun appears in light mode and the moon in dark mode.
  2. Clarify the <img> Tag: Explain the purpose of the <img> tag as a fallback for browsers that don’t support the prefers-color-scheme feature.

Why should the docs be changed? What use cases does it support?

These updates will make the documentation clearer and more practical. Visual aids help users quickly understand the concept, and clarifying the <img> tag’s role will reduce confusion for developers implementing theme-specific images.

What is the expected outcome or behavior?

Users will better understand how to apply theme-specific images with confidence, improving their projects’ appearance across light and dark modes.

Additional information

No response

@syed-ateeb-naveed syed-ateeb-naveed added the content This issue or pull request belongs to the Docs Content team label Sep 23, 2024
Copy link

welcome bot commented Sep 23, 2024

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Sep 23, 2024
@nguyenalex836 nguyenalex836 added waiting for review Issue/PR is waiting for a writer's review get started Content related to "Getting Started" doc set and removed triage Do not begin working on this issue until triaged by the team waiting for review Issue/PR is waiting for a writer's review labels Sep 23, 2024
@nguyenalex836 nguyenalex836 linked a pull request Sep 23, 2024 that will close this issue
2 tasks
@nguyenalex836
Copy link
Contributor

@syed-ateeb-naveed Thank you for opening an issue and linking it to your PR! ✨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team get started Content related to "Getting Started" doc set
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants