docs(image loader/metadata provider): Clarify concept + how-to documentation. #1508
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
NOTE: This PR is currently set to merge into the
beta
branch. We may want to await the merge ofbeta
intomain
first and then merge this PR into main afterwards?Context
This PR improves some Custom Image Loader / Metadata Provider related documentation.
The topic of writing a Custom Image Loader based on the existing DICOM Image Loader goes back years, and I've recently taken the time to research and understand the topic a lot better. (See also #1509 for the resulting PR.) These updates to the documentation are a result of that: they represent links between documentation pages that would have made this a lot clear to begin with.
Open points
I'd like to describe the following better in documentation as well, either in this PR or in follow-up.
Changes & Results
Documentation only.
Testing
N/A
Checklist
PR
semantic-release format and guidelines.
Code
[] My code has been well-documented (function documentation, inline comments,
etc.)
[] I have run the
yarn build:update-api
to update the API documentation, and havecommitted the changes to this PR. (Read more here https://www.cornerstonejs.org/docs/contribute/update-api)
Public Documentation Updates
additions or removals.
Tested Environment