yecol opened a new pull request, #568:
URL: https://github.com/apache/incubator-graphar/pull/568

   <!--
   Thanks for contributing to GraphAr.
   If this is your first pull request you can find detailed information on 
[CONTRIBUTING.md](https://github.com/apache/graphar/blob/main/CONTRIBUTING.md)
   
   The Apache GraphAr (incubating) community has restrictions on the naming of 
pr title. You can find instructions in
   
[CONTRIBUTING.md](https://github.com/apache/graphar/blob/main/CONTRIBUTING.md#title)
 too.
   -->
   
   ### Reason for this PR
   <!-- 
   Why are you proposing this change? If this is already tracked in an issue, 
please link to the issue here.
   Explaining clearly why this change is beneficial is important for the 
reviewers to understand the context.
   -->
   
   Fix an image cannot display bug when open docs from README docs. 
   
   Currently, the images in the docs are given the relative URL, which will 
lead to a cannot display bug:
   Since clicking from github README, the link will automatically appending a 
'/', e.g., 
   clicking on https://graphar.apache.org/docs/specification/format, 
   it actually open the URL 
https://graphar.apache.org/docs/specification/format/
   
   The endling '/' affected the relative path, (by add an extra level), leading 
the images cannot by found and return a 404 error. 
   
   <img width="994" alt="Screenshot 2024-07-31 at 15 23 35" 
src="https://github.com/user-attachments/assets/5c6f0fd3-2fdf-4d9c-860f-6fb19bfe51c1";>
   
   
   ### What changes are included in this PR?
   <!-- 
   There is no need to duplicate the description in the issue here but it is 
sometimes worth providing a summary of the individual changes in this PR.
   -->
   
   Using absolute path can solve this problem.
   Better still, even the [docs in github repo kept correctly 
displayed](https://github.com/yecol/incubator-graphar/blob/docs/docs/specification/format.md).
   
   <!--
   If there are any breaking changes to public APIs, please uncomment the line 
below and explain which changes are breaking.
   -->
   <!-- **BREAKING CHANGE: <description>** -->
   
   <!--
   Please uncomment the line below (and provide explanation) if the changes fix 
either
   (a) a security vulnerability,
   (b) a bug that caused incorrect or invalid data to be produced, or
   (c) a bug that causes a crash (even when the API contract is upheld). 
   We use this to highlight fixes to issues that may affect users without their 
knowledge. For this reason, fixing bugs that cause errors don't count, since 
those are usually obvious.
   -->
   <!-- **Critical Fix: <description>** -->
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to