stan-dev / stan-dev/rstan

move wiki-based OS X Mojave instructions to install page

Open
#704 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
R
Stars
1.1k
Forks
266
Avg merge
2h 56m
Merged PRs (30d)
1

Description

Summary:

Right now there is a wiki page:

https://github.com/stan-dev/rstan/wiki/RStan-Mojave-Mac-OS-X-Prerequisite-Installation-Instructions

about a particular aspect of Mac OS X installation. Can we roll that into the basic install instructions?

https://github.com/stan-dev/rstan/wiki/RStan-Getting-Started

Otherwise, I fear people won't find it. Right now, there's a bunch of links from Mac OS:

  1. https://github.com/stan-dev/rstan/wiki/RStan-Getting-Started says "If you use a Mac, a link will appear but do not click on it. Instead go here", and here links to

  2. https://github.com/stan-dev/rstan/wiki/Installing-RStan-from-source-on-a-Mac#prerequisite--c-toolchain-and-configuration, which has two options for more instructions

3a. (not Mojave?) https://github.com/coatless/r-macos-rtools#how-do-i-use-the-installer
3b. Mojave: https://thecoatlessprofessor.com/programming/r-compiler-tools-for-rcpp-on-macos/

I don't see any links to the above Wiki on instruction.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the RStan-Getting-Started and Installing-RStan-from-source-on-a-Mac wiki pages with the RStan-Mojave-Mac-OS-X-Prerequisite-Installation-Instructions page. Start by tracing the existing Mac links and determine where the Mojave guidance belongs. Done means the relevant instructions are available from the basic install page without requiring users to discover a separate wiki page.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.