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

add mainpage for doxygen with link to other documentation #698

Merged
merged 1 commit into from
Dec 10, 2024

Conversation

iantaylor-NOAA
Copy link
Contributor

What is the feature?

  • Adds some text to the main doxygen page pointing to other documentation sources so it's not just a blank page from which it's hard to return to the rest of FIMS. This was discussed by the documentation group led by @Bai-Li-NOAA in July (notes here) but I had hoped for additional improvements. I now think that including this simple change in M2 is a good first step and the page can be improved further in future milestones.

How have you implemented the solution?

  • Add a mainpage.dox file which will be compiled by the build-deploy-doxygen github action https://github.com/NOAA-FIMS/FIMS/actions/workflows/build-deploy-doxygen.yml although that will only run when dev is merged into main. The results of this PR are shown in the page on the right in screenshot below which was created by manually triggering the workflow on the doxygen-mainpage branch which temporarily replaced the doxygen page and then running it again on main to roll it back to the status-quo (left side of screenshot).
    image

Does the PR impact any other area of the project, maybe another repo?

  • No

@iantaylor-NOAA iantaylor-NOAA added kind: documentation Improvements or additions to documentation attribute: low hanging 🍎 Easy to knock off in less than 1 day labels Dec 9, 2024
Copy link
Contributor

github-actions bot commented Dec 9, 2024

Instructions for code reviewer

Hello reviewer, thanks for taking the time to review this PR!

  • Please use this checklist during your review, checking off items that you have verified are complete!
  • For PRs that don't make changes to code (e.g., changes to README.md or Github actions workflows), feel free to skip over items on the checklist that are not relevant. Remember it is still important to do a thorough review.
  • Then, comment on the pull request with your review indicating where you have questions or changes need to be made before merging.
  • Remember to review every line of code you’ve been asked to review, look at the context, make sure you’re improving code health, and compliment developers on good things that they do.
  • PR reviews are a great way to learn, so feel free to share your tips and tricks. However, for optional changes (i.e., not required for merging), please include nit: (for nitpicking) before making the suggestion. For example, nit: I prefer using a data.frame() instead of a matrix because...
  • Engage with the developer when they respond to comments and check off additional boxes as they become complete so the PR can be merged in when all the tasks are fulfilled. Make it clear when this has been reached by commenting on the PR with something like This PR is now ready to be merged, no changes needed.

Checklist

  • The PR is requested to be merged into the appropriate branch (typically main)
  • The code is well-designed.
  • The functionality is good for the users of the code.
  • Any User Interface changes are sensible and look good.
  • The code isn’t more complex than it needs to be.
  • Code coverage remains high, indicating the new code is tested.
  • The developer used clear names for everything.
  • Comments are clear and useful, and mostly explain why instead of what.
  • Code is appropriately documented (doxygen and roxygen).

@kellijohnson-NOAA
Copy link
Contributor

Thanks @iantaylor-NOAA for this PR. I ❤️ it and would have never known to do this. I think it is a great addition to the doxygen website. I fixed the spelling of "documentation", changed the style to use "Javadoc-style" instead of "Qt-style", spelled out FIMS, added the standard @file and @copyright tags to the file, and complied the doxygen on my machine locally using the following code to ensure it rendered appropriately given the style changes.

rm -r build
cmake -S . -B build -G Ninja
cmake --build build --parallel 16

I will merge in once all the checks have passed.

@kellijohnson-NOAA kellijohnson-NOAA merged commit b68d11e into dev Dec 10, 2024
10 checks passed
@kellijohnson-NOAA kellijohnson-NOAA deleted the doxygen_mainpage branch December 10, 2024 11:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
attribute: low hanging 🍎 Easy to knock off in less than 1 day kind: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants