Closes #2370 general issue developer notes in newsmd and documenting under the hood changes

[bms63]

Thank you for your Pull Request! We have developed this task checklist from the Development Process Guide to help with the final steps of the process. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the admiral codebase remains robust and consistent.

Please check off each taskbox as an acknowledgment that you completed the task or check off that it is not relevant to your Pull Request. This checklist is part of the Github Action workflows and the Pull Request will not be merged into the main branch until you have checked off each task.

• [ ] Place Closes # into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update)
• [ ] Code is formatted according to the tidyverse style guide. Run styler::style_file() to style R and Rmd files
• [ ] Updated relevant unit tests or have written new unit tests, which should consider realistic data scenarios and edge cases, e.g. empty datasets, errors, boundary cases etc. - See Unit Test Guide
• [ ] If you removed/replaced any function and/or function parameters, did you fully follow the deprecation guidance?
• [ ] Review the Cheat Sheet. Make any required updates to it by editing the file inst/cheatsheet/admiral_cheatsheet.pptx and re-upload a PDF version of it to the same folder.
• [ ] Update to all relevant roxygen headers and examples, including keywords and families. Refer to the categorization of functions to tag appropriate keyword/family.
• [ ] Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately
• [ ] Address any updates needed for vignettes and/or templates
• [ ] Update NEWS.md under the header # admiral (development version) if the changes pertain to a user-facing function (i.e. it has an @export tag) or documentation aimed at users (rather than developers)
• [ ] Build admiral site pkgdown::build_site() and check that all affected examples are displayed correctly and that all new functions occur on the "Reference" page.
• [ ] Address or fix all lintr warnings and errors - lintr::lint_package()
• [ ] Run R CMD check locally and address all errors and warnings - devtools::check()
• [ ] Link the issue in the Development Section on the right hand side.
• [ ] Address all merge conflicts and resolve appropriately
• [ ] Pat yourself on the back for a job well done! Much love to your accomplishment!

[bms63]

Hi all,

I made a collapsible News section for tracking Developer Notes/Issues.

I think going forward we are going to be making more under the hood changes and I'd like to track these things. I'm a bit weary of using Milestones as I like everything being in one file with minimal fuss.

Best to view the News.md files as rendered - https://github.com/pharmaverse/admiral/blob/2370-general-issue-developer-notes-in-newsmd-and-documenting-under-the-hood-changes/NEWS.md

Curious to see how it looks on the website once merged

[github-actions[bot]]

Package	Line Rate	Health
admiral	98%	✔
Summary	98% (4732 / 4820)	✔

[zdz2101]

Looks like the staged dependencies stuff is breaking across the board, @pharmaverse/admiral the issue is also showing in other repos like pharmaverseadam

[bms63]

Looks like the staged dependencies stuff is breaking across the board, @pharmaverse/admiral the issue is also showing in other repos like pharmaverseadam

I believe this is due to our updates happening in admiraldev

[zdz2101]

Looks like the staged dependencies stuff is breaking across the board, @pharmaverse/admiral the issue is also showing in other repos like pharmaverseadam

I believe this is due to our updates happening in admiraldev

it's been fixed/addressed between yesterday and today

[bundfussr]

Curious to see how it looks on the website once merged

@bms63 , unfortunately the link to the image is broken on the website:

[bms63]

ummm....as much as I appreciated the image, I kind of didn't like how much "real estate" it took over. Sort of why I wanted to reduce the visibility of developer specific updates.

I'm inclined to just remove the image.