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

Starting updates to docs #7116

Merged
merged 10 commits into from
Oct 27, 2023
Merged

Starting updates to docs #7116

merged 10 commits into from
Oct 27, 2023

Conversation

ericspod
Copy link
Member

Description

This updates the docs with a minor fix to the bundle metadata example and adds diagrams to help explain MONAI, and bundles vs. MAPs.

Types of changes

  • Non-breaking change (fix or new feature that would not break existing functionality).
  • Breaking change (fix or new feature that would cause existing functionality to change).
  • New tests added to cover the changes.
  • Integration tests passed locally by running ./runtests.sh -f -u --net --coverage.
  • Quick tests passed locally by running ./runtests.sh --quick --unittests --disttests.
  • In-line docstrings updated.
  • Documentation updated, tested make html command in the docs/ folder.

ericspod and others added 7 commits October 11, 2023 15:31
Signed-off-by: Eric Kerfoot <eric.kerfoot@kcl.ac.uk>
Signed-off-by: Eric Kerfoot <eric.kerfoot@kcl.ac.uk>
Signed-off-by: Eric Kerfoot <eric.kerfoot@kcl.ac.uk>
Signed-off-by: Eric Kerfoot <eric.kerfoot@kcl.ac.uk>
Signed-off-by: Eric Kerfoot <eric.kerfoot@kcl.ac.uk>
docs/images/MONAI_arch.png Outdated Show resolved Hide resolved
Copy link

@vikashg vikashg left a comment

Choose a reason for hiding this comment

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

I hope this is useful.
Thanks

docs/source/bundle_intro.rst Show resolved Hide resolved
docs/source/bundle_intro.rst Show resolved Hide resolved
ericspod and others added 2 commits October 26, 2023 16:21
Signed-off-by: Eric Kerfoot <eric.kerfoot@kcl.ac.uk>
Signed-off-by: Eric Kerfoot <17726042+ericspod@users.noreply.github.com>
@ericspod ericspod marked this pull request as ready for review October 26, 2023 15:33
Copy link
Contributor

@wyli wyli left a comment

Choose a reason for hiding this comment

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

Thanks, it looks good to me.

Signed-off-by: Wenqi Li <831580+wyli@users.noreply.github.com>
@wyli
Copy link
Contributor

wyli commented Oct 27, 2023

/build

@wyli wyli dismissed vikashg’s stale review October 27, 2023 10:39

thank you, follow-up documentation updates could be included in further PRs.

@wyli wyli enabled auto-merge (squash) October 27, 2023 10:39
@wyli wyli merged commit 487f98b into Project-MONAI:dev Oct 27, 2023
28 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.

4 participants