| [omr-dev] OMR documentation |
The source of the Eclipse OMR website can be accessed here: https://github.com/eclipse/omr.website. We should have the website up and running soon (https://bugs.eclipse.org/bugs/show_bug.cgi?id=499128). Thanks Charlie for working to get the infrastructure ready!
The website will be a central location to access OMR component documentation, links to blogs, conference talks, etc. It will link to the technical documentation.
At the moment, the main OMR repository contains a "doc" directory that currently contains the coding standard as well as some technical documentation about the compiler. There are some efforts underway to add to this documentation, such as:
https://github.com/eclipse/omr/pull/339
https://github.com/eclipse/omr/pull/340
Based on the earlier discussions on the mailing list, it seems the general consensus is to have the docs and code in the same repository, so we should continue to contribute under this doc directory. But I suggest we figure out how it should be organized.
I have opened an issue (https://github.com/eclipse/omr/issues/352) to discuss how we should continue to organize the structure of the technical documentation. There are a few options that we can consider:
| Regards, Dorra Bouchiha, Ph.D. OMR Project Manager IBM Runtime Technologies Eclipse OMR on github.com |
| Phone: 1-905-413-4475 | Mobile: 1-416-702-7440 E-mail: dorrab@xxxxxxxxxx Chat:  dorrab Find me on:   and within IBM on:  |  8200 Warden Ave Markham, ON L6G 1C7 Canada |