/community-faqs

General guides and FAQs destined for RStudio Community (community.rstudio.com)

RStudio Community FAQ Revamp

As part of my 2019 internship with RStudio, I embarked on a top-to-bottom revamp of RStudio Community's FAQ documentation and user guides. In some cases, this involved copy edits and small tweaks to improve clarity and organization. In other cases, I rewrote entire articles, or wrote entirely new collections of guides.

Improving reproducible example guidance

A key goal of refreshing the FAQs was to improve our guidance on the nuts and bolts of composing reproducible examples, with an eye especially to those new to programming and to R. This large sub-project involved writing several new guides. The drafts live in their own repository:

🔗 Reprex How-To

Major rewrites

The final drafts of FAQ articles that were completely rewritten are contained in this repo. Further updates and changes will occur on the Community site itself, so refer to the link for the latest version.

Note that although these files are written in Markdown, the source is optimized for some of Discourse's specific formatting quirks and features. Images may look excessively large when viewed on GitHub, since many of them are relying on Discourse's custom extension to Markdown image syntax that automatically creates click-to-expand thumbnail images.

Tips for writing R-related questions

FAQ: How to format your code

FAQ: How do I mark a solution?

FAQ: Is it OK if I cross-post?

FAQ: Homework Policy

FAQ: How do I track categories or tags? / FAQ: How do I change how I'm notified about a discussion?

These two existing articles had largely overlapping content. Since they both have inbound links, I left them as-is for the time being, but used the same contents for both. Probably one should be deleted and/or re-directed to the other.

Minor refreshes

These articles were edited directly on the Community site, so no drafts exist. But for reference, here are links to the current versions of the guides that only received minor improvements: