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

improve ocamlbuild documentation #6089

Closed
vicuna opened this issue Jul 26, 2013 · 2 comments
Closed

improve ocamlbuild documentation #6089

vicuna opened this issue Jul 26, 2013 · 2 comments

Comments

@vicuna
Copy link

vicuna commented Jul 26, 2013

Original bug ID: 6089
Reporter: william
Assigned to: @Octachron
Status: resolved (set by @Octachron on 2017-08-06T19:08:33Z)
Resolution: fixed
Priority: normal
Severity: feature
Category: -for ocamlbuild use https://github.com/ocaml/ocamlbuild/issues

Bug description

Hello, I would be happy to update a bit the wiki
http://brion.inria.fr/gallium/index.php/Gallium and http://caml.inria.fr/pub/docs/manual-ocaml-4.00/manual032.html

In particular, seperate what belongs to the reference manual (put in ocaml manual), and what belongs to the html wiki doc (examples, tutorials, less technical wording). Also, put aside all "inefficient" text, which talks about the tool without really teaching how to use it.

I would like no to spend too much time on this, and in particular on discussing each details and each wording. However, if I start to change things, it would be hard for you to track each modification, so at some point you would need to trust me, while you don't know me.

I think I could start by explaining in a doc what I plan to change for each paragraph, and if that suits you start working on it. I would need technical information on how to edit the manuals.

I am not real expert of ocaml and ocamlbuild, but as a "beginner" I think I remember quite many things during my learning of the tool, that could be useful to put in documentation.

what is your opinion on that ?

@vicuna
Copy link
Author

vicuna commented Jul 27, 2013

Comment author: meyer

william, while the official manual is hard to change for non developers, I think it would good to give you access to the wiki. I will ping relevant people to allow you to edit the content (if it's not possible at the moment, as I didn't check it yet!), thanks.

@vicuna
Copy link
Author

vicuna commented Aug 6, 2017

Comment author: @Octachron

Ocamlbuild and its documentation has been moved to https://github.com/ocaml/ocamlbuild .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants