search

rescript-association / reasonml.org

Deprecated in favor of rescript-lang.org
MIT License
125 stars 33 forks source link

Inline bs-blabla to the BuckleScript docs #100

Closed ryyppy closed 4 years ago

ryyppy commented 4 years ago

BuckleScript needs a dedicated section for all its external decorators, such as [@bs.module], with proper examples and more thorough explanation on its use-cases.

bs-blabla is probably the most complete documentation on all available decorators so far, so it would be great to process the material in a way so it's easy to navigate on the docs. (I asked the original author for permission, not sure if he still needs to add a license file though)

How to do this? All bucklescript related information lives in the pages/docs/reason-compiler/latest directory. The navigation can be extended in layouts/ReasonCompilerDocsLayout.re.

fhammerschmidt commented 4 years ago

I gladly would tackle this.

bs-blabla is probably not the most accurate name, though.

I would suggest to use bs-decorators instead for the doc title. Or do you have something better in mind?

ryyppy commented 4 years ago

Sure, give it a preferred name and place a link in the ReasonCompilerLayout in the Interop category maybe? There's also a reference to bs-blabla in the documentazion itself somewhere which needs to be redirected as well 👍

ryyppy commented 4 years ago

Done 🎉