Add the 1D wave.jl documentation into example.md

[cquiroz1031]

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.

• [ ] Code follows the style guidelines OR N/A.
• [ ] Unit tests are included OR N/A.
• [ ] Code is exercised in an integration test OR N/A.
• [X] Documentation has been added/updated OR N/A.

[valeriabarra]

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.

┌ Error: invalid local link/image: path pointing to a file outside of build directory in docs/src/examples.md
│   link =
│    @ast MarkdownAST.Image("../assets/wave_end.png", "") do
│      MarkdownAST.Text("wave_end.png")
│    end
│    
└ @ Documenter ~/.julia/packages/Documenter/tbj1p/src/utilities/utilities.jl:47
┌ Error: invalid local link/image: path pointing to a file outside of build directory in docs/src/examples.md
│   link =
│    @ast MarkdownAST.Image("../assets/wave.gif", "") do
│      MarkdownAST.Text("wave.gif")
│    end
│    
└ @ Documenter ~/.julia/packages/Documenter/tbj1p/src/utilities/utilities.jl:47

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

[valeriabarra]

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

[cquiroz1031]

I have gone through with the local build. Here are the screenshots of the added documentation.

[valeriabarra]

Hi @cquiroz1031 , thank you for updating your work. Because your branch is now out-of-date with the main branch, you need to update it. I would personally use git rebase this way:

1. switch to main with: git checkout main
2. git pull
3. switch back to your branch with: git checkout your_branch_name
4. git rebase main your_branch_name

[cquiroz1031]

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.

[valeriabarra]

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!

[valeriabarra]

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 main branch. Thank you