|
22 | 22 | //<![CDATA[ |
23 | 23 |
|
24 | 24 | //]]> |
25 | | -</script></head><body><div class="page-header"><p class="logo-ocsigen"><a href=".././" class="ocsimore_phrasing_link"><img src=".././img/ocsigen-white.svg" alt="Ocsigen"/></a> |
26 | | -</p><div class="mainmenu"><p class="mainmenu-current mainmenu-home"><a href=".././" class="ocsimore_phrasing_link">Home</a></p><p class="mainmenu-doc"><a href=".././tuto/" class="ocsimore_phrasing_link">Doc</a></p><p><a href=".././eliom/" class="ocsimore_phrasing_link">Eliom</a></p><p><a href=".././js_of_ocaml/" class="ocsimore_phrasing_link">Js_of_ocaml</a></p><p><a href=".././lwt/" class="ocsimore_phrasing_link">Lwt</a></p><p><a href=".././tyxml/" class="ocsimore_phrasing_link">Tyxml</a></p><p><a href=".././ocsigen-start/" class="ocsimore_phrasing_link">Start</a></p></div><form id="googlesearch" action="https://google.com/search"><input name="q" id="gsearch-box" placeholder="Search using Google"/><label for="gsearch-box"><img src="/img/search.svg" alt="" id="gsearch-icon"/></label><input type="submit" id="gsearch-submit" onclick="document.getElementById('gsearch-box').value += ' site:ocsigen.org';"/></form><aside class="how-drawer"><input id="how-drawer-toggle" type="checkbox"/><label for="how-drawer-toggle" id="how-drawer-label"><span class="how-drawer-icon"></span></label><nav class="how-drawer-content"><ul class="drawermainmenu"><li class="drawermainmenu-home"><a href=".././" class="ocsimore_phrasing_link">Home</a> |
27 | | -</li><li class="drawermainmenu-doc"><a href=".././tuto/" class="ocsimore_phrasing_link">Doc</a> |
28 | | -</li><li class="drawermainmenu-project"><a href=".././eliom/" class="ocsimore_phrasing_link">Eliom</a> |
29 | | -</li><li class="drawermainmenu-project"><a href=".././js_of_ocaml/" class="ocsimore_phrasing_link">Js_of_ocaml</a> |
30 | | -</li><li class="drawermainmenu-project"><a href=".././ocsigenserver/" class="ocsimore_phrasing_link">Server</a> |
31 | | -</li><li class="drawermainmenu-project"><a href=".././lwt/" class="ocsimore_phrasing_link">Lwt</a> |
32 | | -</li><li class="drawermainmenu-project"><a href=".././tyxml/" class="ocsimore_phrasing_link">Tyxml</a> |
33 | | -</li><li class="drawermainmenu-project"><a href=".././ocsigen-toolkit/" class="ocsimore_phrasing_link">Toolkit</a> |
34 | | -</li><li class="drawermainmenu-project"><a href=".././ocsigen-start/" class="ocsimore_phrasing_link">Start</a> |
35 | | -</li><li class="drawermainmenu-project"><a href=".././html_of_wiki/" class="ocsimore_phrasing_link">html_of_wiki</a> |
36 | | -</li><li class="drawermainmenu-project"><a href=".././deriving/" class="ocsimore_phrasing_link">deriving</a> |
37 | | -</li><li class="drawermainmenu-project"><a href=".././ocsimore/" class="ocsimore_phrasing_link">Ocsimore (<em>deprecated</em>)</a> |
38 | | -</li><li class="drawermainmenu-page"><a href=".././projects" class="ocsimore_phrasing_link">Other projects</a> |
39 | | -</li><li class="drawermainmenu-page"><a href=".././papers" class="ocsimore_phrasing_link">Research papers</a> |
40 | | -</li><li class="drawermainmenu-page"><a href=".././credits" class="ocsimore_phrasing_link">Who does Ocsigen?</a> |
41 | | -</li><li class="drawermainmenu-page"><a href=".././contributing" class="ocsimore_phrasing_link">Contributing</a> |
42 | | -</li><li class="drawermainmenu-page"><a href=".././blog" class="ocsimore_phrasing_link">Blog</a> |
| 25 | +</script></head><body><div class="page-header"><p class="logo-ocsigen"><a href=".././../../" class="ocsimore_phrasing_link"><img src=".././../../img/ocsigen-white.svg" alt="Ocsigen"/></a> |
| 26 | +</p><div class="mainmenu"><p class="mainmenu-current mainmenu-home"><a href=".././../../" class="ocsimore_phrasing_link">Home</a></p><p class="mainmenu-doc"><a href=".././../../tuto/" class="ocsimore_phrasing_link">Doc</a></p><p><a href=".././../../eliom/" class="ocsimore_phrasing_link">Eliom</a></p><p><a href=".././../../js_of_ocaml/" class="ocsimore_phrasing_link">Js_of_ocaml</a></p><p><a href=".././../../lwt/" class="ocsimore_phrasing_link">Lwt</a></p><p><a href=".././../../tyxml/" class="ocsimore_phrasing_link">Tyxml</a></p><p><a href=".././../../ocsigen-start/" class="ocsimore_phrasing_link">Start</a></p></div><form id="googlesearch" action="https://google.com/search"><input name="q" id="gsearch-box" placeholder="Search using Google"/><label for="gsearch-box"><img src="/img/search.svg" alt="" id="gsearch-icon"/></label><input type="submit" id="gsearch-submit" onclick="document.getElementById('gsearch-box').value += ' site:ocsigen.org';"/></form><aside class="how-drawer"><input id="how-drawer-toggle" type="checkbox"/><label for="how-drawer-toggle" id="how-drawer-label"><span class="how-drawer-icon"></span></label><nav class="how-drawer-content"><ul class="drawermainmenu"><li class="drawermainmenu-home"><a href=".././../../" class="ocsimore_phrasing_link">Home</a> |
| 27 | +</li><li class="drawermainmenu-doc"><a href=".././../../tuto/" class="ocsimore_phrasing_link">Doc</a> |
| 28 | +</li><li class="drawermainmenu-project"><a href=".././../../eliom/" class="ocsimore_phrasing_link">Eliom</a> |
| 29 | +</li><li class="drawermainmenu-project"><a href=".././../../js_of_ocaml/" class="ocsimore_phrasing_link">Js_of_ocaml</a> |
| 30 | +</li><li class="drawermainmenu-project"><a href=".././../../ocsigenserver/" class="ocsimore_phrasing_link">Server</a> |
| 31 | +</li><li class="drawermainmenu-project"><a href=".././../../lwt/" class="ocsimore_phrasing_link">Lwt</a> |
| 32 | +</li><li class="drawermainmenu-project"><a href=".././../../tyxml/" class="ocsimore_phrasing_link">Tyxml</a> |
| 33 | +</li><li class="drawermainmenu-project"><a href=".././../../ocsigen-toolkit/" class="ocsimore_phrasing_link">Toolkit</a> |
| 34 | +</li><li class="drawermainmenu-project"><a href=".././../../ocsigen-start/" class="ocsimore_phrasing_link">Start</a> |
| 35 | +</li><li class="drawermainmenu-project"><a href=".././../../html_of_wiki/" class="ocsimore_phrasing_link">html_of_wiki</a> |
| 36 | +</li><li class="drawermainmenu-project"><a href=".././../../deriving/" class="ocsimore_phrasing_link">deriving</a> |
| 37 | +</li><li class="drawermainmenu-project"><a href=".././../../ocsimore/" class="ocsimore_phrasing_link">Ocsimore (<em>deprecated</em>)</a> |
| 38 | +</li><li class="drawermainmenu-page"><a href=".././../../projects" class="ocsimore_phrasing_link">Other projects</a> |
| 39 | +</li><li class="drawermainmenu-page"><a href=".././../../papers" class="ocsimore_phrasing_link">Research papers</a> |
| 40 | +</li><li class="drawermainmenu-page"><a href=".././../../credits" class="ocsimore_phrasing_link">Who does Ocsigen?</a> |
| 41 | +</li><li class="drawermainmenu-page"><a href=".././../../contributing" class="ocsimore_phrasing_link">Contributing</a> |
| 42 | +</li><li class="drawermainmenu-page"><a href=".././../../blog" class="ocsimore_phrasing_link">Blog</a> |
43 | 43 | </li><li class="drawermainmenu-page"><a href="https://github.com/ocsigen" class="ocsimore_phrasing_link">Source code</a> |
44 | 44 | </li></ul><nav class="how-doctree"></nav></nav></aside></div><div class="project-page"><div class="rightcol"><header><h1>Contributing to Ocsigen</h1></header><h2>For individual contributers</h2><p>To contribute to an Ocsigen project, first see the guidelines it provides. It |
45 | 45 | will give you the directives on how to make your contribution. Once ready, |
|
50 | 50 | free to push and the CI will tell you if your documentation has errors. It |
51 | 51 | will only be deployed to <a href="https://ocsigen.org" class="ocsimore_phrasing_link">https://ocsigen.org</a> when merged on <span class="monospace">wikidoc</span>. |
52 | 52 | </p><p>The documentation format is the wikicréole. Please find the reference |
53 | | -<a href=".././html_of_wiki/" class="ocsimore_phrasing_link">here</a>. |
| 53 | +<a href=".././../../html_of_wiki/" class="ocsimore_phrasing_link">here</a>. |
54 | 54 | You can generate the documentation of your API directly in Ocsigen's wikicréole |
55 | 55 | using <span class="teletype">ocamldoc</span>. Do not hesitate to ask for help if you experience any trouble. |
56 | 56 | </p><p>Remember, you have to issue <strong>2</strong> pull requests—one for your code on <span class="monospace">master</span> |
|
65 | 65 | </li></ol><p>Also do not forget to push on <span class="monospace">wikidoc</span> as it will update the website |
66 | 66 | automatically for the new version. |
67 | 67 | </p><h2>Local documentation generation</h2><p>html_of_wiki can (to some extent) locally generate your documentation. Please |
68 | | -find its manual <a href=".././html_of_wiki/" class="ocsimore_phrasing_link">here</a>. |
| 68 | +find its manual <a href=".././../../html_of_wiki/" class="ocsimore_phrasing_link">here</a>. |
69 | 69 | Each project, on the <span class="monospace">wikidoc</span> branch, contains a file <span class="monospace">how.json</span>. Please |
70 | 70 | ensure that its configuration is correct for your changes. The following |
71 | 71 | steps require you to be at <em>the root of the project</em>. |
|
79 | 79 | </li></ul><pre>quickdop -f DOCS _doc -t json -c how.json -viul |
80 | 80 | </pre><p>If you want to avoid generating the whole documentation—just some parts of |
81 | 81 | it—read the documentation of the tools <strong><span class="teletype">dop</span></strong> and <strong><span class="teletype">ohow</span></strong> in |
82 | | -<a href=".././html_of_wiki/" class="ocsimore_phrasing_link">the manual of html_of_wiki</a>.</p></div></div><div class="main-page-section main-page-section-about"><div class="main-page-section-content"><ul><li> <a href=".././credits" class="ocsimore_phrasing_link">Who does Ocsigen?</a> |
83 | | -</li><li> <a href=".././papers" class="ocsimore_phrasing_link">Research papers</a> |
84 | | -</li><li> <a href=".././projects" class="ocsimore_phrasing_link">All the projects</a> |
85 | | -</li><li> <a href=".././contributing" class="ocsimore_phrasing_link">Contributing</a> |
86 | | -</li><li> <a href=".././blog" class="ocsimore_phrasing_link">Blog</a> |
| 82 | +<a href=".././../../html_of_wiki/" class="ocsimore_phrasing_link">the manual of html_of_wiki</a>.</p></div></div><div class="main-page-section main-page-section-about"><div class="main-page-section-content"><ul><li> <a href=".././../../credits" class="ocsimore_phrasing_link">Who does Ocsigen?</a> |
| 83 | +</li><li> <a href=".././../../papers" class="ocsimore_phrasing_link">Research papers</a> |
| 84 | +</li><li> <a href=".././../../projects" class="ocsimore_phrasing_link">All the projects</a> |
| 85 | +</li><li> <a href=".././../../contributing" class="ocsimore_phrasing_link">Contributing</a> |
| 86 | +</li><li> <a href=".././../../blog" class="ocsimore_phrasing_link">Blog</a> |
87 | 87 | </li><li> <a href="https://github.com/ocsigen" class="ocsimore_phrasing_link">Source code</a></li></ul></div></div></body></html> |
0 commit comments