GeezerVison is showing github.com — Update basic-writing-and-formatting-syntax.md by syed-ateeb-naveed · Pull Request #34693 · github/docs
Conversation
In the heading "Specifying the theme an image is shown to", added a Note to clarify the purpose of the tag and added the code itself to display the picture for illustration.
Why:
I was just reading the docs to improve my README, where I came across this code and noticed there was no picture attached for illustration. Furthermore, I also noticed an <img> tag, but its purpose was not given, so I decided to clarify it with NOTE.
Closes:
GitHub Docs Issue #34694
What's being changed (if available, include any code snippets, screenshots, or gifs):
Before:

After:

Shows a picture of moon and stars, as I have dark mode selected
Check off the following:
-
I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).
- For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the
data directory.
-
For content changes, I have completed the self-review checklist.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Dila333 reacted with rocket emoji
In the heading "Specifying the theme an image is shown to", added a Note to clarify the purpose of the <img> tag and added the code itself to display the picture for illustration.
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.
|
Dila333 reacted with rocket emoji
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Automatically generated comment ℹ️
This comment is automatically generated and will be overwritten every time changes are committed to this branch.
The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.
Content directory changes
You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.
fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
syed-ateeb-naveed reacted with heart emoji
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert 👀
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
@syed-ateeb-naveed Thank you for your patience while our SME team reviewed! You are absolutely correct regarding the lack of illustration and the need to more clearly define the purpose of the <img> tag ✨
While we feel your updates to more clearly define the purpose of the <img> tag may be slightly too general, rest assured we will be reviewing internally how best to address the article as a whole as thoughtfully as possible 💛
Thank you so much for raising a flag on these issues, and your willingness to contribute to our docs! 🙇
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Assignees
No one assigned
Labels
content
This issue or pull request belongs to the Docs Content team
get started
Content related to "Getting Started" doc set
SME reviewed
An SME has reviewed this issue/PR
Milestone
No milestone
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
|