Documentation: Review Readme

[aaehmann]

Let us know where something needs a refresh or put your idea here!

Review readme to ensure it is up to date
Clean up any checks failing when posting blogs

Sarita Singh, Shan Lee

[fshanlee]

Shan's Feedback regarding README

• Would it be possible to get links to open in new tabs? For example, when I click the first link in the README, pharmaverse blog, the blog page opens in the same tab as the README, so I have to use my browser's back button to return to the README. This is not a showstopper, but just something that I sometimes find inconvenient.
• Another minor comment is consistency of use of upper case versus lower case when referring to blog posts: first section refers to "blog posts"; second section refers to "Blog Posts".
• Step 3 of "How can I make a Blog Post" says to "Source the script help_create_blogpost.R", but does not mention allowed_tags.R, which is included in line 5 of create_blogpost.R.
• Add some explanation of list.files(), which is called at line 8 of create_blogpost.R, i.e. should I run that line of code (and the call to print() at line 10) before proceeding to enter information into the create_post() function?
• Include some explanation of the appendix.R file that is created within the "zzz_DO_NOT_EDIT..." directory: Is the blogger supposed to edit this file, or just leave it alone?

TBC