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.

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

Update documentation with new features and instructions for new blocks #113

Merged
merged 42 commits into from
Jul 10, 2024

Conversation

menon-karthik
Copy link
Member

@menon-karthik menon-karthik commented Jun 27, 2024

Current situation

Closes #66
We recently had a few new features implemented (or in soon-to-be-merged PRs). So I made some updates to the documentation to reflect those changes.

Release Notes

Documentation

This is the documentation.

Testing

Documentation builds. Did not change anything else.

Code of Conduct & Contributing Guidelines

Copy link

codecov bot commented Jun 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.25%. Comparing base (688cece) to head (db7deda).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #113   +/-   ##
=======================================
  Coverage   79.25%   79.25%           
=======================================
  Files          52       52           
  Lines        2179     2179           
  Branches      278      278           
=======================================
  Hits         1727     1727           
  Misses        452      452           

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

@menon-karthik menon-karthik marked this pull request as ready for review June 27, 2024 00:32
@menon-karthik menon-karthik added the documentation Improvements or additions to documentation label Jun 27, 2024
@menon-karthik menon-karthik self-assigned this Jun 27, 2024
@menon-karthik menon-karthik requested a review from mrp089 July 8, 2024 20:02
Copy link
Member

@mrp089 mrp089 left a comment

Choose a reason for hiding this comment

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

Looks very nice! Thank you for updating the documentation! I added a few minor ideas.

docs/pages/main.md Outdated Show resolved Hide resolved
docs/pages/main.md Outdated Show resolved Hide resolved
docs/pages/developer_guide.md Outdated Show resolved Hide resolved
docs/pages/add_block.md Outdated Show resolved Hide resolved
docs/pages/add_block.md Outdated Show resolved Hide resolved
docs/pages/add_block.md Outdated Show resolved Hide resolved
docs/pages/add_block.md Outdated Show resolved Hide resolved
docs/pages/add_block.md Outdated Show resolved Hide resolved
docs/pages/add_block.md Outdated Show resolved Hide resolved
@mrp089
Copy link
Member

mrp089 commented Jul 9, 2024

The macos-11 GitHub runner is not available anymore as of July, so I removed it.

I added a macos-latest runner (and ubuntu-latest) so we always stay up to date. However, there seems to be a problem with conda. Up to you, @menon-karthik, if you want to do this upgrade now or leave it for a later PR.

@menon-karthik
Copy link
Member Author

The macos-11 GitHub runner is not available anymore as of July, so I removed it.

I added a macos-latest runner (and ubuntu-latest) so we always stay up to date. However, there seems to be a problem with conda. Up to you, @menon-karthik, if you want to do this upgrade now or leave it for a later PR.

I think it's a good idea to stay ahead of the curve, so let's upgrade that right away. I fixed the conda problem by using conda-incubator to find conda and add it to the path. Also, it looks like macos-12 is also going to be removed soon. I will create a new issue and PR to upgrade that just so it is recorded.

@mrp089 mrp089 merged commit 88bc130 into SimVascular:master Jul 10, 2024
6 checks passed
@menon-karthik menon-karthik deleted the update_docs branch October 17, 2024 20:43
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.

Document how to add new blocks
2 participants