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.

Sign up for GitHub

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

Jump to bottom

Update documentation for new developers #256

Merged
merged 23 commits into from
Jan 30, 2024
Merged

Update documentation for new developers #256

merged 23 commits into from
Jan 30, 2024

Conversation

milanmlft
Copy link
Member

@milanmlft milanmlft commented Jan 29, 2024 •
edited
Loading

Update the module READMEs with more details regarding setup, usage and rationale.

  • cli
  • hasher
  • orthanc
  • pixl_core
  • pixl_dcmd
  • pixl_ehr
  • pixl_pacs
  • test
  • main

Fixes #242, #249, #257

@milanmlft milanmlft requested a review from a team January 29, 2024 14:54
stefpiatek
stefpiatek reviewed Jan 29, 2024
View reviewed changes
cli/README.md Show resolved Hide resolved
cli/README.md Outdated Show resolved Hide resolved
cli/pyproject.toml Show resolved Hide resolved
jeremyestein
jeremyestein reviewed Jan 29, 2024
View reviewed changes
pixl_core/README.md Outdated Show resolved Hide resolved
@milanmlft milanmlft marked this pull request as ready for review January 29, 2024 18:39
jeremyestein
jeremyestein reviewed Jan 30, 2024
View reviewed changes
pixl_core/README.md Outdated Show resolved Hide resolved
@milanmlft milanmlft enabled auto-merge (squash) January 30, 2024 13:43
@milanmlft milanmlft requested a review from stefpiatek January 30, 2024 13:51
ruaridhg
ruaridhg approved these changes Jan 30, 2024
View reviewed changes
Copy link
Contributor

@ruaridhg ruaridhg left a comment

Choose a reason for hiding this comment

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

Looks great! 🚀

@milanmlft milanmlft merged commit 3d55ebe into main Jan 30, 2024
8 checks passed
@milanmlft milanmlft deleted the milanmlft/new-dev-docs-issue-242 branch January 30, 2024 16:32
@milanmlft milanmlft mentioned this pull request Jan 30, 2024
Closed
stefpiatek
stefpiatek reviewed Jan 30, 2024
View reviewed changes
Copy link
Contributor

@stefpiatek stefpiatek left a comment

Choose a reason for hiding this comment

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

Some suggestions, sorry didn't make it in time for getting in pre merge!

cli/README.md Show resolved Hide resolved
cli/README.md Show resolved Hide resolved
hasher/README.md Show resolved Hide resolved
@milanmlft milanmlft mentioned this pull request Jan 30, 2024
Merged
@milanmlft
Copy link
Member Author

Suggestions addressed in #269

@milanmlft milanmlft mentioned this pull request Feb 6, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stefpiatek stefpiatek stefpiatek left review comments

@ruaridhg ruaridhg ruaridhg approved these changes

@jeremyestein jeremyestein Awaiting requested review from jeremyestein

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation for new developers
4 participants
@milanmlft @jeremyestein @stefpiatek @ruaridhg