149 revise documentation #840

Job	Run time
Version Bump 🤜🤛	0s
Coverage 📔 / Coverage 📔	2m 50s
Coverage 📔 / Covtracer 🐄	0s
Audit Dependencies 🕵️‍♂️ / oysteR scan 🦪	1m 37s
R CMD Check 🧬 / ghcr.io/insightsengineering/rstudio, version latest	3m 20s
gitleaks 💧 / gitleaks 💧	2s
gitleaks 💧 / PII Check 💳	0s
Grammar Check 🔤 / Check 📝	7s
License Check 🃏 / Check 🚩	36s
Check URLs 🌐 / Validate Links 🔎	7s
SuperLinter 🦸‍♀️ / SuperLinter 🦸‍♂️	1m 35s
SuperLinter 🦸‍♀️ / Lint R code 🧶	1m 35s
Spell Check 🆎 / Check spelling 🔠	1m 32s
Roxygen 🅾 / Manual pages check 🏁	2m 0s
Style Check 👗 / Check code style 🔠	1m 47s
Version Check 🏁 / Emoji in NEWS.md 📰	7s
Version Check 🏁 / Version check 🏁	4s
Coverage 📔 / Publish coverage report 📰	0s
R CMD Check 🧬 / Upload build tar.gz	0s
R CMD Check 🧬 / Publish JUnit HTML report 📰	0s
	17m 19s

Provide feedback