Skip to content

overhauled README, added examples and hopefully made things clearer - #120

Merged
Hendrik-code merged 9 commits into
mainfrom
documentation_update
Aug 4, 2026
Merged

overhauled README, added examples and hopefully made things clearer#120
Hendrik-code merged 9 commits into
mainfrom
documentation_update

Conversation

@Hendrik-code

Copy link
Copy Markdown
Owner

No description provided.

Copilot AI review requested due to automatic review settings August 3, 2026 14:33
@Hendrik-code Hendrik-code self-assigned this Aug 3, 2026
@Hendrik-code
Hendrik-code requested review from robert-graf and removed request for Copilot August 3, 2026 14:33
@Hendrik-code Hendrik-code added the documentation Improvements or additions to documentation label Aug 3, 2026
Comment thread TPTBox/registration/README.md Outdated
Comment thread TPTBox/stitching/README.md Outdated
Copilot AI review requested due to automatic review settings August 3, 2026 14:48

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR refreshes and expands the project’s Markdown documentation to make TPTBox easier to understand and adopt, adding more examples, screenshots, and a new contribution guide.

Changes:

  • Reworked the top-level README.md structure (features, quick usage, module index, publications).
  • Added/expanded per-subpackage READMEs with more detailed examples and visuals (core pillars, snapshot2D, mesh3D, stitching, segmentation, registration).
  • Added a new CONTRIBUTING.md describing local setup and project style/check commands.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 15 comments.

Show a summary per file
File Description
README.md Reorganized project landing page; added navigation, features list, module index, and publications list.
CONTRIBUTING.md New contributor guide with setup, checks, and code style expectations.
TPTBox/core/README.md Refocused “core” docs around NII/POI/BIDS and added NumPy utility examples.
TPTBox/core/README_NII.md New NII-focused README with a quick usage snippet.
TPTBox/core/README_POI.md New POI-focused README with screenshots and extended examples.
TPTBox/core/README_BIDS.md New BIDS-focused README with dataset iteration and path-derivation examples.
TPTBox/spine/snapshot2D/README.md Added screenshot and a more extensive snapshot example.
TPTBox/mesh3D/README.md Added screenshot, installation section, and a more extensive parallel snapshot example.
TPTBox/stitching/README.md Updated stitching usage example to use file lists and expanded parameters.
TPTBox/segmentation/README.md Added a fuller VIBESeg script example and adjusted API documentation.
TPTBox/registration/README.md Added an additional Point_Registration usage example.
Suppressed comments (2)

TPTBox/core/README.md:12

  • The link target here is written as TPTBox/core/README_POI.md, but this README lives inside TPTBox/core/, so that relative link resolves to a non-existent nested path on GitHub. Use a local relative link instead.
### <a href=TPTBox/core/README_POI.md>POI: poi.py -- Points of Interests </a>

TPTBox/registration/README.md:63

  • Spelling/grammar issues in these comments ("resampe", "an specific", "appling") and the NII.load call uses a positional boolean. Fixing this improves readability and makes the snippet clearer for users copying it.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread TPTBox/core/README.md Outdated
Comment thread TPTBox/core/README.md Outdated
Comment thread TPTBox/core/README.md Outdated
Comment thread TPTBox/spine/snapshot2D/README.md Outdated
Comment thread TPTBox/segmentation/README.md
Comment thread TPTBox/mesh3D/README.md
Comment thread TPTBox/stitching/README.md Outdated
Comment thread TPTBox/core/README_POI.md Outdated
Comment thread TPTBox/core/README.md
## Key Classes and Functions

### `nii_wrapper.py` — NIfTI image wrapper
## The three pillars -- NII, POI, BIDS

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Missing one Read-Me for Visualization.

@robert-graf

Copy link
Copy Markdown
Collaborator

I do not like that all images disappear for the main Readme. Instead, we get a wall of text with citations.

I do not like that parts of the main Readme are links (big ugly links in addition)

Hendrik-code and others added 3 commits August 3, 2026 16:59
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@Hendrik-code

Copy link
Copy Markdown
Owner Author

I do not like that all images disappear for the main Readme. Instead, we get a wall of text with citations.

I do not like that parts of the main Readme are links (big ugly links in addition)

Hmm okay, how do you like it to be?
Because if all examples, documentation, and figures are in main README, it becomes unreadable and you cannot find anything anymore. That's why I split this up.
Regarding links being ugly, make it nicer :D

@Hendrik-code
Hendrik-code merged commit e37eb92 into main Aug 4, 2026
5 checks passed
@Hendrik-code
Hendrik-code deleted the documentation_update branch August 4, 2026 08:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants