[DOCS] Update markdown links #1334
Conversation
|
Thanks for fixing the doc!🚀🚀🚀 |
|
|
||
| <img alt="Point buffer with 8 quadrant segments" src="../../../image/point-buffer-quad-8.png" width="100" height=""/> | ||
| <img alt="Point buffer with 2 quadrant segments" src="../../../image/point-buffer-quad-2.png" width="100" height=""/> | ||
| {: width="100px"} |
There was a problem hiding this comment.
When viewing the docs on GitHub this type of syntax does not work with {: width="100px"} being displayed as is.
There was a problem hiding this comment.
It is rendering correctly when the docs is built using these instructions.
There was a problem hiding this comment.
The syntax "{: width="100px"}" is not supported by github. Since there are not that many pictures, what we could do is resize all pictures, and get rid of this. And possibly have a linter? rule on top of it.
There was a problem hiding this comment.
Best practice for web development is to serve images with the correct dimensions and avoid scaling down the images with HTML so that you don't waste users' data and hurt page performance.
https://web.dev/articles/serve-images-with-correct-dimensions
There was a problem hiding this comment.
I issued a new pull request: #1359, hope it helps!
* Update links in code documentation across various files and some minor grammar fixes. * [DOCS] Fix line breaks
Did you read the Contributor Guide?
Is this PR related to a JIRA ticket?
[DOCS] my subject.What changes were proposed in this PR?
Correct relative paths and including .md in the links so this is better picked up in ide, eg no more 404's when browsing the documentation in GitHub.
How was this patch tested?
I checked for broken links and verified images are being displayed correctly.
Did this PR include necessary documentation updates?