-
Notifications
You must be signed in to change notification settings - Fork 90
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Switch bash driver with bsdoc #269
Conversation
After long playing around with the bash script used to drive odoc for BuckleScript projects, I decided it could be turned into a cli tool, npm-installable, that would do the same thing without requiring copying files around or leaking how odoc needs to be orchestrated. This could pave the way to a deeper integration with the BuckleScript platform, perhaps in the future `bsdoc` can be absorbed into it. So here I just replace the references to such script with references to the tool instead. Let me know what you think! cc/ @aantron @trefis @ryyppy @bobzhang
README.md
Outdated
λ eval `opam config env` | ||
λ opam pin add odoc.dev git+https://github.com/ocaml/odoc | ||
|
||
$ cd MyProject |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given that the instructions are already provided in bsdoc
's README, I don't think it's necessary to repeat them here. Each tool should be responsible for its own documentation, otherwise things will get out of date eventually.
It's good to see progress in this direction. Even though this is much better than the bash script I understand there might be some obstacles on both sides but it would be good to enumerate them. Specifically:
|
@rizo, opened rescript-lang/rescript-compiler#3198 to keep track of the BuckleScript side of the integration. Hopefully it pans out like the I'll update the commits to just point to the |
From looking at the Reason and BuckleScript project I see two big outstanding things we should work on:
But I don't see any blocking issues on the |
Thansk @Ostera! We can continue the discussion on the issue you opened. |
After long playing around with the bash script used to drive odoc for
BuckleScript projects, I decided it could be turned into a cli tool,
npm-installable, that would do the same thing without requiring copying
files around or leaking how odoc needs to be orchestrated.
This could pave the way to a deeper integration with the BuckleScript
platform, perhaps in the future
bsdoc
can be absorbed into it.So here I just replace the references to such script with references to
the tool instead.
Let me know what you think!
cc/ @aantron @trefis @ryyppy @bobzhang