stan-dev / stan-dev/rstan

Reorganize install instructions as interface-specific checklist

Open
#324 6 comments 0 reactions 1 assignee View on GitHub

@jgabry is already working on this.

Since Aug 14, 2016.

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

Description

Summary:

Make the installation instructions for RStan

  • easier to follow for users, and
  • easier for us to diagnose when users have problems.
Description:
  1. Organize instructions by interface. Have a separate page of instructions for each platform (Windows, Mac OSX, Linux). These can even be broken down by version of OS if they're different in more than one place. It's the combinatorics of the instructions that are daunting.
  2. Organize instructions as step-by-step checklist.
  3. Ideally, for each step, provide a way to verify that it was done correctly.
  4. Even better, provide troubleshooting advice related to checklist items to help users self-diagnose problems and allow us to see at exactly which step things went wrong for user installs.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.