From 330840338cd0c45f4083f0dc3140bd7e465da23a Mon Sep 17 00:00:00 2001
From: Jerin Philip <jphilip@ed.ac.uk>
Date: Tue, 1 Jun 2021 12:39:28 +0100
Subject: [PATCH] Including WASM documentation in sphinx build toc (#176)

---
 doc/index.rst       |  1 +
 doc/wasm-example.md |  1 +
 wasm/README.md      | 24 ++++++++++++++++--------
 3 files changed, 18 insertions(+), 8 deletions(-)
 create mode 120000 doc/wasm-example.md

diff --git a/doc/index.rst b/doc/index.rst
index 85bc7f1..5be3857 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -15,6 +15,7 @@ This is developer documentation.
    :caption: Contents:
 
    marian-integration
+   wasm-example
    api/library_index
 
 
diff --git a/doc/wasm-example.md b/doc/wasm-example.md
new file mode 120000
index 0000000..9188e93
--- /dev/null
+++ b/doc/wasm-example.md
@@ -0,0 +1 @@
+../wasm/README.md
\ No newline at end of file
diff --git a/wasm/README.md b/wasm/README.md
index eceac15..01fea18 100644
--- a/wasm/README.md
+++ b/wasm/README.md
@@ -1,9 +1,17 @@
-## Using Bergamot Translator in JavaScript
-The example file `bergamot.html` in the folder `test_page` demonstrates how to use the bergamot translator in JavaScript via a `<script>` tag.
+# Using Bergamot Translator in JavaScript
 
-### <a name="Pre-requisite"></a> Pre-requisite: Download files required for translation
+Instructions in this document assume current-directory to be
+[wasm](https://github.com/browsermt/bergamot-translator/tree/main/wasm) within
+bergamot-translator source.
 
-Please note that [Using JS APIs](#Using-JS-APIs) and [Demo](#Demo) section below assumes that the [bergamot project specific model files](https://github.com/mozilla-applied-ml/bergamot-models) are already downloaded and present in the `test_page` folder. If this is not done then use following instructions to do so:
+The example file `bergamot.html` in the folder `test_page` demonstrates how to
+use the bergamot translator in JavaScript via a `<script>` tag.
+
+## Pre-requisites
+
+**Download files required for translation**
+
+Please note that [Using JS APIs](#using-js-apis) and [Demo](#demo) section below assumes that the [bergamot project specific model files](https://github.com/mozilla-applied-ml/bergamot-models) are already downloaded and present in the `test_page` folder. If this is not done then use following instructions to do so:
 
 ```bash
 cd test_page
@@ -13,7 +21,7 @@ cp -rf bergamot-models/prod/* models
 gunzip models/*/*
 ```
 
-### <a name="Using-JS-APIs"></a> Using JS APIs
+## Using JS APIs
 
 ```js
 // The model configuration as YAML formatted string. For available configuration options, please check: https://marian-nmt.github.io/docs/cmd/marian-decoder/
@@ -79,9 +87,9 @@ request.delete();
 input.delete();
 ```
 
-### <a name="Demo"></a> Demo (see everything in action)
+## Demo 
 
-* Make sure that you followed [Pre-requisite](#Pre-requisite) instructions before moving forward.
+* Make sure that you followed [Pre-requisites](#pre-requisites) instructions before moving forward.
 
 * Start the test webserver (ensure you have the latest nodejs installed)
     ```bash
@@ -112,4 +120,4 @@ input.delete();
 * Run some translations:
     * Choose a model and press `Load Model`
     * Type a sentence to be translated in the `From` textbox and press `Translate`
-    * See the results in the `To` and `Log` textboxes
\ No newline at end of file
+    * See the results in the `To` and `Log` textboxes