-
Notifications
You must be signed in to change notification settings - Fork 16
Add the 1D wave.jl documentation into example.md #2301
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
base: main
Are you sure you want to change the base?
Conversation
Hi @cquiroz1031 , thank you for your contribution! There are a couple of error messages in the doc build. It is recommended that you test the doc build on your local machine before pushing to the PR.
To see these error messages, click on the failing GitHub Action check: Try to fix these locally and push to your branch again. Thank you |
To test the documentation build locally and make sure that it looks how you intended it to look, please refer to the Contributing guide and post screenshots of your local build results here in the PR convo so we can have a quick preview of the docs. Thank you |
Hi @cquiroz1031 , thank you for updating your work.
|
Hello @valeriabarra, thanks for the feedback and update suggestion. I've now updated the branch to be up to date with the current version of ClimaCore.jl and pushed the new documentation. |
Hi @cquiroz1031 , it appears like you did not update your branch properly, as GitHub is still showing you have conflicts to be resolved. Also, please post updated screenshots of your portion of the built documentation after you update your branch. Thank you! |
Hi @cquiroz1031 , please see my latest comment above. You still need to update your branch with the |
Adds a new subsection to examples.md containing documentation for the wave.jl 1D wave equation example implemented with ClimaCore.
This documentation is intended to provide a simple, self-contained example for new users of ClimaCore.