Skip to content

Commit 6f08429

Browse files
committed
Add wave animation graphic to new documentation pages
1 parent a2b4fe7 commit 6f08429

6 files changed

Lines changed: 24 additions & 3 deletions

File tree

docs/_main_pages/developer_docs/build_docs.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,3 +66,6 @@ Then open `http://localhost:4000/HydroChrono/`.
6666
- First run fetches the remote theme; ensure internet connectivity.
6767

6868

69+
<p align="center">
70+
<img src="https://nrel.github.io/HydroChrono/assets/img/wave_animation2.gif" alt="Wave Energy" width="80%" />
71+
</p>

docs/_main_pages/developer_docs/build_instructions.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,4 +133,8 @@ This summarizes PASS/FAIL and embeds plots for the standard regression cases.
133133
- Chrono/HydroChrono build types must match (e.g., both Release, same version of Visual Studio, etc.)
134134
- `yaml-cpp.dll` or other dlls missing → ensure they are next to the exe
135135
- GUI skybox missing → ensure `data/skybox/` exists in the install ZIP (packaging now includes it)
136-
- Python tests: install `numpy`, `h5py`, `PyYAML`, `matplotlib`, or run `tests/RUN-TESTS.ps1`
136+
- Python tests: install `numpy`, `h5py`, `PyYAML`, `matplotlib`, or run `tests/RUN-TESTS.ps1`
137+
138+
<p align="center">
139+
<img src="https://nrel.github.io/HydroChrono/assets/img/wave_animation2.gif" alt="Wave Energy" width="80%" />
140+
</p>

docs/_main_pages/developer_docs/cmake_build_basics.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,4 +66,8 @@ cmake --build build --config Debug
6666
## See also
6767

6868
- [CMake: CMAKE\_BUILD\_TYPE](https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html)
69-
- [CMake: CMAKE\_CONFIGURATION\_TYPES](https://cmake.org/cmake/help/latest/variable/CMAKE_CONFIGURATION_TYPES.html)
69+
- [CMake: CMAKE\_CONFIGURATION\_TYPES](https://cmake.org/cmake/help/latest/variable/CMAKE_CONFIGURATION_TYPES.html)
70+
71+
<p align="center">
72+
<img src="https://nrel.github.io/HydroChrono/assets/img/wave_animation2.gif" alt="Wave Energy" width="80%" />
73+
</p>

docs/_main_pages/developer_docs/cmake_build_structure.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,3 +153,6 @@ CPack (ZIP): `cpack -C Release` yields a ready‑to‑share artifact.
153153
- [CMake Build Basics](cmake_build_basics)
154154
- [Project Chrono Documentation](https://api.projectchrono.org/)
155155

156+
<p align="center">
157+
<img src="https://nrel.github.io/HydroChrono/assets/img/wave_animation2.gif" alt="Wave Energy" width="80%" />
158+
</p>

docs/_main_pages/developer_docs/contribution_guidelines.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,4 +171,8 @@ Foo::~Foo() noexcept = default;
171171
- [ ] Ownership and lifetime clear; destructors `noexcept` where reasonable
172172
- [ ] Exceptions are specific; error messages add context
173173
- [ ] Logging used for user-facing messages (no stray `cout`)
174-
- [ ] Tests updated/added when logic changes
174+
- [ ] Tests updated/added when logic changes
175+
176+
<p align="center">
177+
<img src="https://nrel.github.io/HydroChrono/assets/img/wave_animation2.gif" alt="Wave Energy" width="80%" />
178+
</p>

docs/_main_pages/new_model.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,3 +160,6 @@ run_hydrochrono.exe .\my_model\my_model.setup.yaml
160160
Outputs are written to `my_model/outputs/`.
161161

162162

163+
<p align="center">
164+
<img src="https://nrel.github.io/HydroChrono/assets/img/wave_animation2.gif" alt="Wave Energy" width="80%" />
165+
</p>

0 commit comments

Comments
 (0)