docs: improve image customization guidance and clean up broken links #489
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… sizes Signed-off-by: Zihan Kuang <[email protected]>
✅ Deploy Preview for bejewelled-pegasus-b0ce81 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
miacycle
approved these changes
Apr 25, 2025
|
Uh-oh, a merge conflict. |
leecalcote
approved these changes
Apr 25, 2025
Signed-off-by: Zihan Kuang <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
[x] Yes, I signed my commits.
This PR includes the following documentation improvements:
Added image customization guidance
Introduced a new subsection under “Image styling” that explains how to override the default image rendering using raw HTML for tall, narrow, or awkwardly displayed images.
Removed broken links and fragile code file URLs
Cleaned up outdated or fragile hyperlinks, especially those pointing directly to GitHub files or anchors that are prone to 404 errors. Replaced them with plain text file paths where appropriate.
Refactored the Documentation Style Guide section
Slightly restructured and clarified the “Overriding theme styles”.