TrizTech/ohif-viewer
17
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Alireza authored and GitHub committed 2023-06-20 10:26:05 -04:00
1 parent 5670a1699d
commit 83c453d1f3
428 files changed
+271 -9666
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

platform/docs/src/css/custom.css
+13
View File
@@ -273,3 +273,16 @@ html[data-theme='dark'] .docusaurus-highlight-code-line {
padding: 0 var(--ifm-pre-padding);
border-left: 3px solid #ff000080;
}
.new-badge::after,
.deprecated-badge::after {
font-size: 11px;
@apply inline-flex items-center justify-center rounded-sm;
@apply ml-1.5 px-1 py-0;
}
.new-badge::after {
content: ' (NEW)';
@apply bg-red-300 text-red-500;
@apply dark:bg-blue-900 dark:text-blue-100;
}
platform/docs/src/pages/versions.md
+6 -40
View File
@@ -5,50 +5,16 @@ with the latest software engineering practices, here we are listing the versions
the OHIF platform that we are currently supporting, and the versions that have been
deprecated.
## Product Version vs Package Version
## Product Version
There are two types of versions that we need to consider here:
- Product Version: which is the end user visible version of the viewer
- Package Version: which is the underlying libraries/packages of the platform on npm.
Currently we have three product versions:
- Version 1 (deprecated): Built with Meteor as a full stack application.
- Version 2 (master branch): Front end image viewer built with React
- Version 3 (alpha release): Re-architected Version 2.0 to allow for a more modular and customizable viewer.
As per package versioning, we follow semantic versioning which looks like *a.b.c* where:
- *a* is for major breaking changes
- *b* is for new features
- *c* is for patches/bug fixes
You can read more semantic versioning [here](https://semver.org/).
- Version 2 (deprecated): Front end image viewer built with React
- Version 3.x-beta (master branch): With latest bug fixes and features but not yet released (released under beta)
- Version 3.x (release branch): Released version of the OHIF platform which is more stable and tested
## Maintained Product Versions
### Version 3.1 Cornerstone3D
OHIF Version 3.1 is the next major upcoming release of the OHIF platform. It uses
the next generation of the cornerstone library, [Cornerstone 3D](https://github.com/cornerstonejs/cornerstone3D-beta).
We are in the process of performing a parity check between this version and the `master`
branch before we merge it into the master branch. You can read more about the
roadmap timelines [here](https://ohif.org/roadmap/).
### Version 2.0: Master branch
Currently, the master branch of OHIF is on Product Version 2.0.
## Archived Versions
### Version 3.0 Cornerstone Legacy
Version 3.0 which uses [cornerstone-core](https://github.com/cornerstonejs/cornerstone) and
[cornerstone-tools](https://github.com/cornerstonejs/cornerstoneTools) for rendering and
manipulation/annotation of images.
### Version 1.0 Meteor
Deprecated in favor of Version 2.0. Built using full stack Meteor as a full stack application.
You can read more about the differences between the versions in the [development section](../../docs/development/getting-started#branches) of the documentation
to understand which version is more suitable for your use case.