Skip to content
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

Merged
merged 2 commits into from
Dec 12, 2018
Merged

Switch bash driver with bsdoc #269

merged 2 commits into from
Dec 12, 2018

Conversation

leostera
Copy link
Collaborator

@leostera leostera commented Dec 7, 2018

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

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
Copy link
Collaborator

@rizo rizo Dec 8, 2018

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.

@rizo
Copy link
Collaborator

rizo commented Dec 8, 2018

It's good to see progress in this direction. Even though this is much better than the bash script bsdoc replaces, I still think we should make efforts to integrate odoc with BuckleScript officially (if that is what the community wants).

I understand there might be some obstacles on both sides but it would be good to enumerate them. Specifically:

@leostera
Copy link
Collaborator Author

@rizo, opened rescript-lang/rescript-compiler#3198 to keep track of the BuckleScript side of the integration.

Hopefully it pans out like the dune one and there's nothing to be changed in odoc.

I'll update the commits to just point to the bsdoc docs!

@leostera
Copy link
Collaborator Author

@rizo: What is currently missing in odoc in terms of features to support BuckleScript projects?

From looking at the Reason and BuckleScript project I see two big outstanding things we should work on:

  1. Bring Reason Syntax up to par with Refmt v3 #199 — bring reason syntax up to par is important, since most BuckleScript users would come from the Reason side of the community.

  2. Reason/OCaml syntax switching #129 — switching syntaxes would then again make all docs readable for both parts of the ecosystem.

But I don't see any blocking issues on the odoc side. The namespacing one stands out but it's on bucklescript's court.

@rizo
Copy link
Collaborator

rizo commented Dec 12, 2018

Thansk @Ostera! We can continue the discussion on the issue you opened.

@rizo rizo merged commit e7395cd into ocaml:master Dec 12, 2018
@leostera leostera deleted the docs/bsdoc branch December 13, 2018 16:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants