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

[WIP] Setup initial documentation #54

Draft
wants to merge 19 commits into
base: main
Choose a base branch
from

Conversation

patrickersing
Copy link
Contributor

@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

@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.27%. Comparing base (9f05124) to head (6c8f8e9).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #54   +/-   ##
=======================================
  Coverage   99.27%   99.27%           
=======================================
  Files          60       60           
  Lines        2626     2626           
=======================================
  Hits         2607     2607           
  Misses         19       19           

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

This project has benefited from funding from [Vetenskapsrådet](https://www.vr.se)
(VR, Swedish Research Council), Sweden
through the VR Starting Grant "Shallow water flows including sediment transport and morphodynamics",
VR grant agreement 2020-03642 VR.

**Note: This repository is still in its alpha stage and anything might change at
Copy link
Member

Choose a reason for hiding this comment

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

This part should be removed

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Do you refer to the note about being in alpha stage or the acknowledgements?

Copy link
Member

Choose a reason for hiding this comment

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

The alpha stage. Most parts should be relatively stable as far as I have observed, and the remaining breaking changes can be reflected by new version numbers. This should at least be the case when the package is kind of "published officially".

Copy link
Member

Choose a reason for hiding this comment

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

Definitely, I agree. We can ditch this alpha stage note. We just got confused whether or not you meant the statement acknowledging VR.

Copy link
Member

Choose a reason for hiding this comment

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

Sorry - I couldn't comment only on the alpha stage part since it was not changed directly in this PR 🙈

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