search

janestreet / bonsai

A library for building dynamic webapps, using Js_of_ocaml
MIT License
368 stars 39 forks source link

Fix Getting Started path in README #9

Closed nekketsuuu closed 4 years ago

nekketsuuu commented 4 years ago

It seems that https://github.com/janestreet/bonsai/commit/6e62a5a6d9fdc621cd5cf2ac8d264720829814d2 adds /docs/getting_started/open_source/index.md and the file /docs/getting_started/index.md hasn't been published since the "Getting Started" link was inserted in README with this commit https://github.com/janestreet/bonsai/commit/221df1ab368c351064fbdcaf3bb7e3fb7c7762c8.

nekketsuuu commented 4 years ago

Related: https://github.com/janestreet/bonsai/issues/6

TyOverby commented 4 years ago

Sadly the patch that you've provided isn't going to be sufficient because of how Jane Street maps internal codebases to the external github repositories.

In this case, there's a "getting started" that focuses on development inside Jane Street, and a "open source" getting started. My mistake was in not mapping the "open source" version to the correct file path so that the readme points to the right directory.

I have a fix developed internally that should move the folder to the right location, and once it's published (typically under a week), the link will be correct!

If it's cool with you, I'm going to leave this PR open until the fix is released as a way to remind me to check in on it if for some reason it doesn't work correctly!

TyOverby commented 4 years ago

Aha! Fixed!