Skip to content

update documentation #66

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

Merged
merged 39 commits into from
Dec 6, 2024
Merged

update documentation #66

merged 39 commits into from
Dec 6, 2024

Conversation

koebel
Copy link
Collaborator

@koebel koebel commented Nov 19, 2024

Description

update documentation

  • better structure of content through TOC
  • adding more detailed description of functionalities
  • adding more information about installation for development and deployment
  • adding information how to add DICOM Viewer to the ocis deployment example (referenced .yml file needs to be merged before this update is published!!!, see adding dicom-viewer.yml #67)

Related Issue

Motivation and Context

make it easier for users understand benefits of the app and to install and use it

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Tests only (no source changes)

Checklist:

  • Code changes
  • Unit tests added
  • Acceptance tests added

@koebel koebel changed the title update description of the app update documentation Nov 19, 2024
@koebel koebel self-assigned this Nov 20, 2024
@koebel koebel marked this pull request as ready for review November 21, 2024 10:46
@mmattel mmattel requested a review from phil-davis November 22, 2024 07:44
@koebel
Copy link
Collaborator Author

koebel commented Nov 25, 2024

only merge after #67 has been merged

@koebel koebel requested review from S-Panta and saw-jan December 6, 2024 08:29
Copy link
Contributor

@S-Panta S-Panta left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link

sonarqubecloud bot commented Dec 6, 2024

@koebel koebel merged commit 7ca90c9 into main Dec 6, 2024
3 checks passed
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.

Update documentation: prerequisites, including supported ocis-web versions and installation
5 participants