Improve docs onboarding documentation

[JonathanMontane]

Do you want to request a feature or report a bug?
Bug in docs/README.md (incomplete documentation).

Bug: What is the current behavior?
The docs app uses rvm to pin the ruby version to 2.3.3. Its documentation, however, is not advocating for the use of rvm or any specific version of ruby, which causes the app to fail to build with [email protected] as some dependencies are not yet compatible with 2.4.

More details (Click to expand)

The docs app uses yajl-ruby which is not yet compatible with `2.4.x` (see: yajl-ruby#164).

On OSX, brew install ruby yields a 2.4.x version, which naturally fails to build the app. The command brew install [email protected] will install the required version, but there can be issues with $PATH, that can be tedious. using rvm is much simpler and will yield cleaner environments for everyone.

Bug: What is the expected behavior?
The onboarding documentation (docs/README.md) details the 2.3.3 requirements for ruby and proposes steps to get this specific version.

Note
I see 3 ways of fixing this:

• add the [email protected] requirement
• add the rvm requirement
• add a Dockerfile and possibly a docker-compose file. The requirements become: Get Docker.

[JonathanMontane]

I can work on this tonight, once the preferred way of fixing this has been chosen.

[bobylito]

Hi @JonathanMontane Thanks for the issue. We're currently working on making a new documentation website which will not rely on Ruby anymore.

Thanks again for taking the time to document and propose a solution ❤️

[JonathanMontane]

Thanks for the heads up!