1071 prerelease cleanup@main

[m7pr]

Close #1071

This PR was meant to update README and DESCRIPTION file up to standards we had for other teal packages before the release. Some of the DESCRIPTION changes are CRAN requirements.

Summary

• Review and update README.md
  • add CRAN badges to README
  • add Getting Help section to README
  • change installation guidelines to use CRAN
  • cleanup usage section
• Package Title is not duplicated in Package Description in DESCRIPTION file
• Make sure all teal.* mentions are lower-cased and quoted
• Make sure each link to our documentation hosted with pkgdown on github pages do not have /main/ in the address
  • it should have has /latest-tag/ instead
  • so we always expose the documentation of the latest release and not what's currently on main branch but not yet released
• All package names in Title and Description fields of DESCRIPTION file are quoted with ' (not backtick)

[m7pr]

Hey @donyunardi @shajoezhu a small PR for the things I reckon we missed during pre-release activities. I know the package was submitted to CRAN but I think it's gonna be rejected because teal was mentioned in DESCRIPTION file with improper backticks.
Feel free to extend USAGE section with a minimal example of how to quickly run this package with maybe one module.

[github-actions]

Unit Tests Summary

  1 files   33 suites   2s ⏱️
150 tests 150 ✅   0 💤 0 ❌
282 runs  170 ✅ 112 💤 0 ❌

Results for commit ab7d230.

♻️ This comment has been updated with latest results.

[shajoezhu]

hi @m7pr , appreciate the fix! I am blocking this merge for now. as i am awaiting for cran submission feedback, if it doesnt succeed in the first round, we will include all changes here, otherwise, let's include this pr, and fix everything in the next round. i submitted the package last night, hopefully we hear something back soon. thanks again!

[m7pr]

I've seen you submitted the package.

I was involved in release and submissions of teal.logger and teal.reporter and this was a NO-GO for CRAN maintainers

All package names in Title and Description fields of DESCRIPTION file are quoted with ' (not backtick)

so I think this submission will be rejected, and that's why I come up with this PR.
If you get a rejection you can use this PR to address any other feedback that they have.

[shajoezhu]

Thanks @m7pr ! Yes, definitely! I don't think it will go through in the first trial, I am hoping to get some feedback and address them according, appreciate that you sharing the latest experience, I think we will include all these changes anyway, let's give it another day

[shajoezhu]

lgtm! Thanks a lot @m7pr

[m7pr]

no worries, happy to help