Skip to content

Readme#166

Merged
alongd merged 5 commits intomainfrom
readme
Apr 10, 2026
Merged

Readme#166
alongd merged 5 commits intomainfrom
readme

Conversation

@alongd
Copy link
Copy Markdown
Member

@alongd alongd commented Apr 9, 2026

updated README, CI, mkdocs

Copy link
Copy Markdown

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

Updates the project documentation and supporting tooling configuration (CI, MkDocs, and Conda environment) to reflect the current workflows and docs site.

Changes:

  • Refreshes README.md with updated badges, feature list, installation/usage examples, and links to the MkDocs site.
  • Simplifies environment.yml by removing explicit channel qualifiers and the anaconda channel, and adding pydantic to conda dependencies.
  • Adjusts automation configs by removing MkDocs Google Analytics config and enabling CI runs on pushes to main.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
README.md Rewrites the README structure (badges/features/install/usage/docs/dev sections) and updates links.
mkdocs.yml Removes legacy Google Analytics configuration from the MkDocs config.
environment.yml Streamlines Conda dependencies/channel usage and adds pydantic.
.github/workflows/ci.yml Triggers CI on push to main in addition to PR/schedule/manual runs.

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

Comment thread README.md
@alongd alongd closed this Apr 9, 2026
@alongd alongd reopened this Apr 9, 2026
@alongd alongd force-pushed the readme branch 2 times, most recently from 53f104b to beab02b Compare April 10, 2026 08:21
alongd added 4 commits April 10, 2026 15:34
@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 72.77%. Comparing base (482fbba) to head (fc56893).
⚠️ Report is 40 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main     #166       +/-   ##
===========================================
+ Coverage   47.55%   72.77%   +25.21%     
===========================================
  Files          25       35       +10     
  Lines        3463     4668     +1205     
  Branches      936      985       +49     
===========================================
+ Hits         1647     3397     +1750     
+ Misses       1607      944      -663     
- Partials      209      327      +118     
Flag Coverage Δ
unittests 72.77% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

@alongd alongd merged commit 069d4d2 into main Apr 10, 2026
4 checks passed
@alongd alongd deleted the readme branch April 10, 2026 17:28
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.

3 participants