Skip to content

Conversation

@d33bs
Copy link
Member

@d33bs d33bs commented Dec 11, 2025

Description

This PR adds a "getting started" section to the readme to make the tutorials and example notebooks easy to find and understand their context to each other in one spot.

What is the nature of your change?

  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • This change requires a documentation update.

Checklist

Please ensure that all boxes are checked before indicating that a pull request is ready for review.

  • I have read the CONTRIBUTING.md guidelines.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • New and existing unit tests pass locally with my changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have deleted all non-relevant text in this pull request template.

@d33bs d33bs marked this pull request as ready for review December 11, 2025 22:05
@d33bs d33bs requested a review from gwaybio as a code owner December 11, 2025 22:05
Co-authored-by: Gregory Way <gregory.way@gmail.com>
@d33bs
Copy link
Member Author

d33bs commented Dec 12, 2025

Thanks @gwaybio ! Will merge this in once tests pass.

@d33bs d33bs merged commit e61cbf9 into cytomining:main Dec 15, 2025
10 checks passed
@d33bs d33bs deleted the readme-guidance branch December 15, 2025 17:17
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.

2 participants