Skip to content

Improved user experience in the OCaml Documentation Tutorials #1554

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Improved user experience in the OCaml Documentation Tutorials #1554

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
60c3b51
changed ocaml manual layout
yashi-hub Apr 22, 2021
f762e13
changed ocaml manual layout
yashi-hub Apr 22, 2021
08529c5
Merge branch 'master' of https://github.com/yashi-hub/ocaml.org
yashi-hub Apr 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 21 additions & 7 deletions site/releases/4.12/htmlman/advexamples.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,26 @@
<link rel="stylesheet" type="text/css" href="manual.css">
<title>OCaml - Advanced examples with classes and modules</title>
<script src="scroll.js"></script><script src="navigation.js"></script><link rel="shortcut icon" type="image/x-icon" href="favicon.ico"></head>
<body><div class="content manual"><div id="sidebar-button"><span>☰</span></div><nav id="part-title"><span>☰</span>An introduction to OCaml</nav><ul id="part-menu"><li><a href="coreexamples.html">The core language</a></li><li><a href="moduleexamples.html">The module system</a></li><li><a href="objectexamples.html">Objects in OCaml</a></li><li><a href="lablexamples.html">Labels and variants</a></li><li><a href="polymorphism.html">Polymorphism and its limitations</a></li><li class="active"><a href="advexamples.html">Advanced examples with classes and modules</a></li></ul>




<h1 class="chapter" id="sec64"><span class="number">Chapter 6</span>Advanced examples with classes and modules</h1>
<body>
<div style="width:100%;position:fixed;" class="content manual" >
<nav><div id="part-title" style="width:95%; background-color: white; position: fixed; top: 0; padding-bottom: 20px;">
<span>☰</span>
An introduction to OCaml
</div>
<div id="sidebar-button" style="width:5%; background-color: white; position: fixed; top: 0; padding-bottom: 100px;"><span>☰</span></div>
</nav>
</div>
<br/><br/>
<div class="right-div" style="position:fixed;">
<ul id="part-menu">
<li><a href="coreexamples.html">The core language</a></li><li><a href="moduleexamples.html">The module system</a></li><li><a href="objectexamples.html">Objects in OCaml</a></li><li><a href="lablexamples.html">Labels and variants</a></li><li><a href="polymorphism.html">Polymorphism and its limitations</a>
</li>
<li class="active"><a href="advexamples.html">Advanced examples with classes and modules</a></li>
</br/></ul>
</div>
<br/><br/>
<div class="content manual" >
<h1 class="chapter" id="sec64"><span class="number">Chapter 6</span>Advanced examples with classes and modules</h1>
<header id="sidebar"><nav class="toc brand"><a class="brand" href="https://ocaml.org/"><img src="colour-logo.svg" class="svg" alt="OCaml"></a></nav><nav class="toc"><div class="toc_version"><a id="version-select" href="https://ocaml.org/releases/">Version 4.12</a></div><div class="toc_title"><a href="index.html">&lt; The OCaml Manual</a></div><ul><li class="top"><a href="#">Advanced examples with classes and modules</a></li>
<li><a href="advexamples.html#s%3Aextended-bank-accounts"><span class="number">1</span>Extended example: bank accounts</a>
</li><li><a href="advexamples.html#s%3Amodules-as-classes"><span class="number">2</span>Simple modules as classes</a>
Expand Down Expand Up @@ -1258,4 +1272,4 @@ <h2 class="section" id="s:subject-observer"><a class="section-anchor" href="#s:s


<span class="authors c010">(Chapter written by Didier Rémy)</span><div class="copyright">Copyright © 2021 Institut National de
Recherche en Informatique et en Automatique</div></div></body></html>
Recherche en Informatique et en Automatique</div></div></body></html>
25 changes: 18 additions & 7 deletions site/releases/4.12/htmlman/afl-fuzz.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,23 @@
<link rel="stylesheet" type="text/css" href="manual.css">
<title>OCaml - Fuzzing with afl-fuzz</title>
<script src="scroll.js"></script><script src="navigation.js"></script><link rel="shortcut icon" type="image/x-icon" href="favicon.ico"></head>
<body><div class="content manual"><div id="sidebar-button"><span>☰</span></div><nav id="part-title"><span>☰</span>The OCaml tools</nav><ul id="part-menu"><li><a href="comp.html">Batch compilation (ocamlc)</a></li><li><a href="toplevel.html">The toplevel system or REPL (ocaml)</a></li><li><a href="runtime.html">The runtime system (ocamlrun)</a></li><li><a href="native.html">Native-code compilation (ocamlopt)</a></li><li><a href="lexyacc.html">Lexer and parser generators (ocamllex, ocamlyacc)</a></li><li><a href="depend.html">Dependency generator (ocamldep)</a></li><li><a href="ocamldoc.html">The documentation generator (ocamldoc)</a></li><li><a href="debugger.html">The debugger (ocamldebug)</a></li><li><a href="profil.html">Profiling (ocamlprof)</a></li><li><a href="intfc.html">Interfacing C with OCaml</a></li><li><a href="flambda.html">Optimisation with Flambda</a></li><li class="active"><a href="afl-fuzz.html">Fuzzing with afl-fuzz</a></li><li><a href="instrumented-runtime.html">Runtime tracing with the instrumented runtime</a></li></ul>




<h1 class="chapter" id="sec546"><span class="number">Chapter 20</span>Fuzzing with afl-fuzz</h1>
<body>
<div style="width:100%;position:fixed;" class="content manual" >
<nav><div id="part-title" style="width:95%; background-color: white; position: fixed; top: 0; padding-bottom: 20px;">
<span>☰</span>
The OCaml tools
</div>
<div id="sidebar-button" style="width:5%; background-color: white; position: fixed; top: 0; padding-bottom: 100px;"><span>☰</span></div>
</nav>
</div>
<br/><br/>
<div class="right-div" style="position:fixed;">
<ul id="part-menu">
<li><a href="comp.html">Batch compilation (ocamlc)</a></li><li><a href="toplevel.html">The toplevel system or REPL (ocaml)</a></li><li><a href="runtime.html">The runtime system (ocamlrun)</a></li><li><a href="native.html">Native-code compilation (ocamlopt)</a></li><li><a href="lexyacc.html">Lexer and parser generators (ocamllex, ocamlyacc)</a></li><li><a href="depend.html">Dependency generator (ocamldep)</a></li><li><a href="ocamldoc.html">The documentation generator (ocamldoc)</a></li><li><a href="debugger.html">The debugger (ocamldebug)</a></li><li><a href="profil.html">Profiling (ocamlprof)</a></li><li><a href="intfc.html">Interfacing C with OCaml</a></li><li><a href="flambda.html">Optimisation with Flambda</a></li><li class="active"><a href="afl-fuzz.html">Fuzzing with afl-fuzz</a></li><li><a href="instrumented-runtime.html">Runtime tracing with the instrumented runtime</a></li></br></ul>
</div>
<br/><br/>
<div class="content manual" >
<h1 class="chapter" id="sec546"><span class="number">Chapter 20</span>Fuzzing with afl-fuzz</h1>
<header id="sidebar"><nav class="toc brand"><a class="brand" href="https://ocaml.org/"><img src="colour-logo.svg" class="svg" alt="OCaml"></a></nav><nav class="toc"><div class="toc_version"><a id="version-select" href="https://ocaml.org/releases/">Version 4.12</a></div><div class="toc_title"><a href="index.html">&lt; The OCaml Manual</a></div><ul><li class="top"><a href="#">Fuzzing with afl-fuzz</a></li>
<li><a href="afl-fuzz.html#s%3Aafl-overview"><span class="number">1</span>Overview</a>
</li><li><a href="afl-fuzz.html#s%3Aafl-generate"><span class="number">2</span>Generating instrumentation</a>
Expand Down Expand Up @@ -67,4 +78,4 @@ <h2 class="section" id="s:afl-example"><a class="section-anchor" href="#s:afl-ex


<div class="copyright">Copyright © 2021 Institut National de
Recherche en Informatique et en Automatique</div></div></body></html>
Recherche en Informatique et en Automatique</div></div></body></html>
26 changes: 19 additions & 7 deletions site/releases/4.12/htmlman/alerts.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,24 @@
<link rel="stylesheet" type="text/css" href="manual.css">
<title>OCaml - Language extensions</title>
<script src="scroll.js"></script><script src="navigation.js"></script><link rel="shortcut icon" type="image/x-icon" href="favicon.ico"></head>
<body><div class="content manual"><div id="sidebar-button"><span>☰</span></div><nav id="part-title"><span>☰</span>The OCaml language</nav><ul id="part-menu"><li><a href="language.html">The OCaml language</a></li><li class="active"><a href="extn.html">Language extensions</a></li></ul>




<h1 class="chapter" id="sec238"><span class="number">Chapter 8</span>Language extensions</h1><header id="sidebar"><nav class="toc brand"><a class="brand" href="https://ocaml.org/"><img src="colour-logo.svg" class="svg" alt="OCaml"></a></nav><nav class="toc"><div class="toc_version"><a id="version-select" href="https://ocaml.org/releases/">Version 4.12</a></div><div class="toc_title"><a href="index.html">&lt; The OCaml Manual</a></div><ul><li class="top"><a href="#">Language extensions</a></li>
<body>
<div style="width:100%;position:fixed;" class="content manual" >
<nav><div id="part-title" style="width:95%; background-color: white; position: fixed; top: 0; padding-bottom: 20px;">
<span>☰</span>
The OCaml language
</div>
<div id="sidebar-button" style="width:5%; background-color: white; position: fixed; top: 0; padding-bottom: 100px;"><span>☰</span></div>
</nav>
</div>
<br/><br/>
<div class="right-div" style="position:fixed;">
<ul id="part-menu">
<li><a href="language.html">The OCaml language</a></li><li class="active"><a href="extn.html">Language extensions</a></li>
</br/></ul>
</div>
<br/><br/>
<div class="content manual" >
<h1 class="chapter" id="sec238"><span class="number">Chapter 8</span>Language extensions</h1><header id="sidebar"><nav class="toc brand"><a class="brand" href="https://ocaml.org/"><img src="colour-logo.svg" class="svg" alt="OCaml"></a></nav><nav class="toc"><div class="toc_version"><a id="version-select" href="https://ocaml.org/releases/">Version 4.12</a></div><div class="toc_title"><a href="index.html">&lt; The OCaml Manual</a></div><ul><li class="top"><a href="#">Language extensions</a></li>
<li><a href="letrecvalues.html#start-section"><span class="number">1</span>Recursive definitions of values</a>
</li><li><a href="manual024.html#start-section"><span class="number">2</span>Recursive modules</a>
</li><li><a href="privatetypes.html#start-section"><span class="number">3</span>Private types</a>
Expand Down Expand Up @@ -110,4 +122,4 @@ <h2 class="section" id="s:alerts"><a class="section-anchor" href="#s:alerts" ari


</section><div class="copyright">Copyright © 2021 Institut National de
Recherche en Informatique et en Automatique</div></div></body></html>
Recherche en Informatique et en Automatique</div></div></body></html>
26 changes: 19 additions & 7 deletions site/releases/4.12/htmlman/attributes.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,24 @@
<link rel="stylesheet" type="text/css" href="manual.css">
<title>OCaml - Language extensions</title>
<script src="scroll.js"></script><script src="navigation.js"></script><link rel="shortcut icon" type="image/x-icon" href="favicon.ico"></head>
<body><div class="content manual"><div id="sidebar-button"><span>☰</span></div><nav id="part-title"><span>☰</span>The OCaml language</nav><ul id="part-menu"><li><a href="language.html">The OCaml language</a></li><li class="active"><a href="extn.html">Language extensions</a></li></ul>




<h1 class="chapter" id="sec238"><span class="number">Chapter 8</span>Language extensions</h1><header id="sidebar"><nav class="toc brand"><a class="brand" href="https://ocaml.org/"><img src="colour-logo.svg" class="svg" alt="OCaml"></a></nav><nav class="toc"><div class="toc_version"><a id="version-select" href="https://ocaml.org/releases/">Version 4.12</a></div><div class="toc_title"><a href="index.html">&lt; The OCaml Manual</a></div><ul><li class="top"><a href="#">Language extensions</a></li>
<body>
<div style="width:100%;position:fixed;" class="content manual" >
<nav><div id="part-title" style="width:95%; background-color: white; position: fixed; top: 0; padding-bottom: 20px;">
<span>☰</span>
The OCaml language
</div>
<div id="sidebar-button" style="width:5%; background-color: white; position: fixed; top: 0; padding-bottom: 100px;"><span>☰</span></div>
</nav>
</div>
<br/><br/>
<div class="right-div" style="position:fixed;">
<ul id="part-menu">
<li><a href="language.html">The OCaml language</a></li><li class="active"><a href="extn.html">Language extensions</a></li>
</br/></ul>
</div>
<br/><br/>
<div class="content manual" >
<h1 class="chapter" id="sec238"><span class="number">Chapter 8</span>Language extensions</h1><header id="sidebar"><nav class="toc brand"><a class="brand" href="https://ocaml.org/"><img src="colour-logo.svg" class="svg" alt="OCaml"></a></nav><nav class="toc"><div class="toc_version"><a id="version-select" href="https://ocaml.org/releases/">Version 4.12</a></div><div class="toc_title"><a href="index.html">&lt; The OCaml Manual</a></div><ul><li class="top"><a href="#">Language extensions</a></li>
<li><a href="letrecvalues.html#start-section"><span class="number">1</span>Recursive definitions of values</a>
</li><li><a href="manual024.html#start-section"><span class="number">2</span>Recursive modules</a>
</li><li><a href="privatetypes.html#start-section"><span class="number">3</span>Private types</a>
Expand Down Expand Up @@ -539,4 +551,4 @@ <h3 class="subsection" id="ss:builtin-attributes"><a class="section-anchor" href


</section><div class="copyright">Copyright © 2021 Institut National de
Recherche en Informatique et en Automatique</div></div></body></html>
Recherche en Informatique et en Automatique</div></div></body></html>
26 changes: 19 additions & 7 deletions site/releases/4.12/htmlman/bigarray.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,24 @@
<link rel="stylesheet" type="text/css" href="manual.css">
<title>OCaml - Language extensions</title>
<script src="scroll.js"></script><script src="navigation.js"></script><link rel="shortcut icon" type="image/x-icon" href="favicon.ico"></head>
<body><div class="content manual"><div id="sidebar-button"><span>☰</span></div><nav id="part-title"><span>☰</span>The OCaml language</nav><ul id="part-menu"><li><a href="language.html">The OCaml language</a></li><li class="active"><a href="extn.html">Language extensions</a></li></ul>




<h1 class="chapter" id="sec238"><span class="number">Chapter 8</span>Language extensions</h1><header id="sidebar"><nav class="toc brand"><a class="brand" href="https://ocaml.org/"><img src="colour-logo.svg" class="svg" alt="OCaml"></a></nav><nav class="toc"><div class="toc_version"><a id="version-select" href="https://ocaml.org/releases/">Version 4.12</a></div><div class="toc_title"><a href="index.html">&lt; The OCaml Manual</a></div><ul><li class="top"><a href="#">Language extensions</a></li>
<body>
<div style="width:100%;position:fixed;" class="content manual" >
<nav><div id="part-title" style="width:95%; background-color: white; position: fixed; top: 0; padding-bottom: 20px;">
<span>☰</span>
The OCaml language
</div>
<div id="sidebar-button" style="width:5%; background-color: white; position: fixed; top: 0; padding-bottom: 100px;"><span>☰</span></div>
</nav>
</div>
<br/><br/>
<div class="right-div" style="position:fixed;">
<ul id="part-menu">
<li><a href="language.html">The OCaml language</a></li><li class="active"><a href="extn.html">Language extensions</a></li>
</br/></ul>
</div>
<br/><br/>
<div class="content manual" >
<h1 class="chapter" id="sec238"><span class="number">Chapter 8</span>Language extensions</h1><header id="sidebar"><nav class="toc brand"><a class="brand" href="https://ocaml.org/"><img src="colour-logo.svg" class="svg" alt="OCaml"></a></nav><nav class="toc"><div class="toc_version"><a id="version-select" href="https://ocaml.org/releases/">Version 4.12</a></div><div class="toc_title"><a href="index.html">&lt; The OCaml Manual</a></div><ul><li class="top"><a href="#">Language extensions</a></li>
<li><a href="letrecvalues.html#start-section"><span class="number">1</span>Recursive definitions of values</a>
</li><li><a href="manual024.html#start-section"><span class="number">2</span>Recursive modules</a>
</li><li><a href="privatetypes.html#start-section"><span class="number">3</span>Private types</a>
Expand Down Expand Up @@ -74,4 +86,4 @@ <h2 class="section" id="s:bigarray-access"><a class="section-anchor" href="#s:bi


</section><div class="copyright">Copyright © 2021 Institut National de
Recherche en Informatique et en Automatique</div></div></body></html>
Recherche en Informatique et en Automatique</div></div></body></html>
25 changes: 18 additions & 7 deletions site/releases/4.12/htmlman/bindingops.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,23 @@
<link rel="stylesheet" type="text/css" href="manual.css">
<title>OCaml - Language extensions</title>
<script src="scroll.js"></script><script src="navigation.js"></script><link rel="shortcut icon" type="image/x-icon" href="favicon.ico"></head>
<body><div class="content manual"><div id="sidebar-button"><span>☰</span></div><nav id="part-title"><span>☰</span>The OCaml language</nav><ul id="part-menu"><li><a href="language.html">The OCaml language</a></li><li class="active"><a href="extn.html">Language extensions</a></li></ul>




<h1 class="chapter" id="sec238"><span class="number">Chapter 8</span>Language extensions</h1><header id="sidebar"><nav class="toc brand"><a class="brand" href="https://ocaml.org/"><img src="colour-logo.svg" class="svg" alt="OCaml"></a></nav><nav class="toc"><div class="toc_version"><a id="version-select" href="https://ocaml.org/releases/">Version 4.12</a></div><div class="toc_title"><a href="index.html">&lt; The OCaml Manual</a></div><ul><li class="top"><a href="#">Language extensions</a></li>
<body><div style="width:100%;position:fixed;" class="content manual" >
<nav><div id="part-title" style="width:95%; background-color: white; position: fixed; top: 0; padding-bottom: 20px;">
<span>☰</span>
The OCaml language
</div>
<div id="sidebar-button" style="width:5%; background-color: white; position: fixed; top: 0; padding-bottom: 100px;"><span>☰</span></div>
</nav>
</div>
<br/><br/>
<div class="right-div" style="position:fixed;">
<ul id="part-menu">
<li><a href="language.html">The OCaml language</a></li><li class="active"><a href="extn.html">Language extensions</a></li>
</br/></ul>
</div>
<br/><br/>
<div class="content manual" >
<h1 class="chapter" id="sec238"><span class="number">Chapter 8</span>Language extensions</h1><header id="sidebar"><nav class="toc brand"><a class="brand" href="https://ocaml.org/"><img src="colour-logo.svg" class="svg" alt="OCaml"></a></nav><nav class="toc"><div class="toc_version"><a id="version-select" href="https://ocaml.org/releases/">Version 4.12</a></div><div class="toc_title"><a href="index.html">&lt; The OCaml Manual</a></div><ul><li class="top"><a href="#">Language extensions</a></li>
<li><a href="letrecvalues.html#start-section"><span class="number">1</span>Recursive definitions of values</a>
</li><li><a href="manual024.html#start-section"><span class="number">2</span>Recursive modules</a>
</li><li><a href="privatetypes.html#start-section"><span class="number">3</span>Private types</a>
Expand Down Expand Up @@ -228,4 +239,4 @@ <h3 class="subsection" id="ss:letops-rationale"><a class="section-anchor" href="


</section><div class="copyright">Copyright © 2021 Institut National de
Recherche en Informatique et en Automatique</div></div></body></html>
Recherche en Informatique et en Automatique</div></div></body></html>
Loading