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

Diagrams in messages document are not rendered #1030

Closed
tienvx opened this issue Dec 21, 2022 · 4 comments
Closed

Diagrams in messages document are not rendered #1030

tienvx opened this issue Dec 21, 2022 · 4 comments
Labels
documentation Indicates a need for improvements or additions to documentation

Comments

@tienvx
Copy link

tienvx commented Dec 21, 2022

Software versions

NA

Issue Checklist

NA

Expected behaviour

Diagrams should be rendered

Actual behaviour

Diagrams are not rendered

Steps to reproduce

Relevant log files

NA

@tienvx tienvx added the bug Indicates an unexpected problem or unintended behavior label Dec 21, 2022
@mefellows mefellows added documentation and removed bug Indicates an unexpected problem or unintended behavior labels Mar 3, 2023
@mefellows mefellows added documentation Indicates a need for improvements or additions to documentation and removed documentation labels Jul 12, 2023
@rubemfsv
Copy link
Contributor

rubemfsv commented Oct 1, 2023

@mefellows I just resolved here: #1119

@rubemfsv
Copy link
Contributor

rubemfsv commented Oct 6, 2023

Resolved and merged #1119
@YOU54F I think it is interesting to close this issue then. Thanks!

@YOU54F
Copy link
Member

YOU54F commented Oct 6, 2023

Not quite just yet unfortunately 😓

  1. we need to check it renders on the site to close this issue
  2. is isn't actually rendering on the site post the update https://docs.pact.io/implementation_guides/javascript/docs/messages

it's unrelated to your change, but related to the docs sync job, which appears to require ?raw=true for the images to render

pact-foundation/docs.pact.io@b4a393b#diff-dd41eeae0d557ea0bd62cbcb2548f88613902e11ed50f3d0d90b547494a129ccL23

See related issue here

pact-foundation/docs.pact.io#265 (comment)

@YOU54F
Copy link
Member

YOU54F commented Oct 6, 2023

I think the links just need to be raw githubusercontent links, ie

https://raw.githubusercontent.com/pact-foundation/pact-js/master/docs/diagrams/message-provider.png

which would resolve it on the site, and when viewed on the repo

@YOU54F YOU54F closed this as completed in dda5c94 Oct 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Indicates a need for improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants