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

chore(version): update cs3d version and add iframe documentation #3474

Merged
merged 16 commits into from
Jun 20, 2023

Conversation

sedghi
Copy link
Member

@sedghi sedghi commented Jun 14, 2023

Context

  • Upgrade version for cs3d
  • remove unnecessary versioned docs for v3
  • rename v2 to v2-deprecated in the docs and v1 to v1-deprecated
  • add iframe docs

Changes & Results

Testing

Checklist

PR

  • [] My Pull Request title is descriptive, accurate and follows the
    semantic-release format and guidelines.

Code

  • [] My code has been well-documented (function documentation, inline comments,
    etc.)

Public Documentation Updates

  • [] The documentation page has been updated as necessary for any public API
    additions or removals.

Tested Environment

  • [] OS:
  • [] Node version:
  • [] Browser:

@netlify
Copy link

netlify bot commented Jun 14, 2023

Deploy Preview for ohif-platform-docs ready!

Name Link
🔨 Latest commit 833102e
🔍 Latest deploy log https://app.netlify.com/sites/ohif-platform-docs/deploys/6491b0cef597b000088975ff
😎 Deploy Preview https://deploy-preview-3474--ohif-platform-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@netlify
Copy link

netlify bot commented Jun 14, 2023

Deploy Preview for ohif-dev canceled.

Name Link
🔨 Latest commit 833102e
🔍 Latest deploy log https://app.netlify.com/sites/ohif-dev/deploys/6491b0ce63582700072d7f29

@codecov
Copy link

codecov bot commented Jun 14, 2023

Codecov Report

Merging #3474 (833102e) into master (d51211f) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #3474   +/-   ##
=======================================
  Coverage   38.27%   38.27%           
=======================================
  Files          82       82           
  Lines        1348     1348           
  Branches      303      303           
=======================================
  Hits          516      516           
  Misses        666      666           
  Partials      166      166           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5670a16...833102e. Read the comment docs.

@cypress
Copy link

cypress bot commented Jun 14, 2023

Passing run #3310 ↗︎

0 36 0 0 Flakiness 0

Details:

fix footer external links
Project: Viewers Commit: 833102eb36
Status: Passed Duration: 03:30 💡
Started: Jun 20, 2023 2:06 PM Ended: Jun 20, 2023 2:09 PM

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings.

@sedghi sedghi changed the title chore(version): update cs3d version chore(version): update cs3d version and add iframe documentation Jun 15, 2023
@sedghi sedghi requested a review from jbocce June 15, 2023 02:25
You need to make sure that the viewer is also built with PUBLIC_URL set to the same path. For example, if you using
`<iframe src="./ohif" />` (which means there is a `ohif` folder containing the build in your main app), then you need to:

1. use a config file that is using the `routerBasename` of `/ohif` (note the one / - it is not /ohif/).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To maybe make step 2 less verbos, say. "use a config file (say myConfig.js) that has routerBasename set to \ohif (note the one / - it is not /ohif/)."

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have a myConfig.js so I think it is fine to explain a bit more

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By adding "(say myConfig.js)" you are saying exactly that to "pretend the config file is named myConfig.js". So please reconsider adding it in.

Copy link
Collaborator

@jbocce jbocce left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. A few changes to make. Thanks so much.

@sedghi sedghi requested a review from jbocce June 16, 2023 21:46
Copy link
Collaborator

@jbocce jbocce left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few more wording issues to clean up. Thanks for doing this. It will definitely come in handy.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants