Skip to content

Update documentation#8

Merged
tsalo merged 5 commits intomainfrom
update-docs
Mar 25, 2026
Merged

Update documentation#8
tsalo merged 5 commits intomainfrom
update-docs

Conversation

@tsalo
Copy link
Member

@tsalo tsalo commented Mar 24, 2026

I tasked Cursor with synchronizing the documentation across ModelArray, ModelArrayIO, and ConFixel.

Related to PennLINC/ModelArray#107 and PennLINC/ConFixel#43.

I tasked Cursor with synchronizing the documentation across ModelArray, ModelArrayIO, and ConFixel.
@tsalo tsalo added the documentation Improvements or additions to documentation label Mar 24, 2026
@tsalo tsalo requested review from Copilot and mattcieslak March 24, 2026 15:17
Copy link

Copilot AI left a comment

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 updates ModelArrayIO documentation to reflect the current CLI naming and project positioning (ModelArrayIO superseding ConFixel/ConVoxel), and adds a lightweight GitHub Pages redirect.

Changes:

  • Refreshes README + walkthroughs to reference ModelArrayIO commands (confixel, convoxel, *stats_write) instead of legacy ConFixel/ConVoxel wording.
  • Updates package metadata (pyproject.toml) description and adds a Documentation URL.
  • Adds docs/ redirect assets (index.html, .nojekyll) to forward GitHub Pages to the GitHub README installation section.

Reviewed changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
tests/data_voxel_toy/README.md Updates toy dataset description to align with ModelArrayIO voxel pipeline naming.
pyproject.toml Updates project description and adds a Documentation URL.
notebooks/walkthrough_voxel-wise_data.md Rewords voxel workflow docs to use convoxel / volumestats_write.
notebooks/walkthrough_fixel-wise_data.md Rewords fixel workflow docs to use confixel / fixelstats_write and updates export notes.
notebooks/README.md Updates notebook index bullets to reflect current CLI commands.
docs/index.html Adds HTML redirect page pointing to GitHub README installation section.
docs/.nojekyll Ensures GitHub Pages serves raw files without Jekyll processing.
README.md Replaces legacy ConFixel-moved notice with ModelArrayIO-centric README and command list.

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

@codecov-commenter
Copy link

codecov-commenter commented Mar 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 39.62%. Comparing base (dbfe3a6) to head (8765704).

Additional details and impacted files
@@           Coverage Diff           @@
##             main       #8   +/-   ##
=======================================
  Coverage   39.62%   39.62%           
=======================================
  Files           8        8           
  Lines         954      954           
=======================================
  Hits          378      378           
  Misses        576      576           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@tsalo tsalo merged commit e5c9f2a into main Mar 25, 2026
8 of 11 checks passed
@tsalo tsalo deleted the update-docs branch March 25, 2026 13:47
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.

4 participants