Skip to content

Setup initial documentation #54

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

Merged
merged 51 commits into from
Apr 8, 2025

Conversation

patrickersing
Copy link
Member

@patrickersing patrickersing commented Aug 21, 2024

This PR creates the initial documentation for TrixiShallowWater.jl.

ToDo:

  • Authors list
  • Tutorials (start with around three)
    • something with wet/dry
    • something with multiple layers
    • something that uses TrixiBottomTopography.jl
  • Installation page
  • Contributing
  • Code of conduct
  • Development and testing
  • security.md

@patrickersing patrickersing added the documentation Improvements or additions to documentation label Aug 21, 2024
@patrickersing patrickersing changed the title Setup initial documentation [WIP] Setup initial documentation Aug 21, 2024
Copy link

codecov bot commented Aug 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.32%. Comparing base (2280912) to head (8c83cda).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #54   +/-   ##
=======================================
  Coverage   99.32%   99.32%           
=======================================
  Files          60       60           
  Lines        2794     2794           
=======================================
  Hits         2775     2775           
  Misses         19       19           

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

Copy link
Member Author

@patrickersing patrickersing left a comment

Choose a reason for hiding this comment

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

@andrewwinters5000 very nice tutorial!
I think it's looks quite good already. I have a few smaller comments and a suggestion how we could streamline the tutorial by setting up everything for the final time directly.

Copy link
Member

@andrewwinters5000 andrewwinters5000 left a comment

Choose a reason for hiding this comment

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

Some small comments as we move closer to the finish line for the docs.

@andrewwinters5000
Copy link
Member

better figure for Okushiri tutorial

shot_for_docs2

Copy link
Member

@andrewwinters5000 andrewwinters5000 left a comment

Choose a reason for hiding this comment

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

Just one final comment and I will push an update to the authors list.

Copy link
Member

@andrewwinters5000 andrewwinters5000 left a comment

Choose a reason for hiding this comment

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

LGTM, Great work @patrickersing ! I think we are ready to pull the ripcord

@andrewwinters5000
Copy link
Member

Last new figure

shot_for_docs3

@patrickersing patrickersing marked this pull request as ready for review April 8, 2025 15:49
@patrickersing patrickersing changed the title [WIP] Setup initial documentation Setup initial documentation Apr 8, 2025
@patrickersing patrickersing merged commit aabdc0a into trixi-framework:main Apr 8, 2025
19 checks passed
@patrickersing patrickersing deleted the initial_docs branch April 8, 2025 16:22
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.

5 participants