C++ Linear Damper Tutorial

[andermi]

tutorial: CppLinearDamperExample

example code: linear_damper_example

[github-actions]

PR Preview Action 6ac6d62
Preview removed because the pull request was closed.
2023-04-10 20:50 UTC

[mabelzhang]

General comment on these tutorials - I've been noticing that at the top, the navigation goes from Home (an icon) directly to the individual "Quick Start -- ..." tutorials. Then if the user clicks on Home, they can't find how to go to other tutorials.

I think we need to add a navigation list for the tutorials to this YAML file, maybe under the Tutorials line:

mbari_wec/docs/mkdocs.yml

Line 10 in f53a957

- Tutorials: tutorials.md

one bullet per tutorial, so that the navigation bar will be like Home > Tutorials > "Quick Start -- ..."

See https://www.mkdocs.org/user-guide/writing-your-docs/#configure-pages-and-navigation

That should probably be done if we have any other subpages at level 3, so that the nav bar goes to level 2 first. Otherwise the default seems to just go from Home.

This can be in a new PR.

[mabelzhang]

Very nice. I'm impressed there are no English typos in this long page 😃

[mabelzhang]

Hmm since my review was requested - looks good to me, but I didn't read the code explanation closely - I think @quarkytale did that. My review was a high-level conceptual read and compiling and running it. Runs for me, buoy moves a bit faster than when it's not running, so I guess it works.

[quarkytale]

Yeah good to go from me too! Though I was still getting the linker error while compiling even on a fresh installation, if it worked for you then perfect, I'll debug my workspace.

[mabelzhang]

linker error

Refers to simple_interp