tidying up the references to the widget

ox-it · Mar 24, 2015 · 1b49159 · 1b49159
1 parent 02fae43
commit 1b49159
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git a/docs/source/http_api/summary.rst b/docs/source/http_api/summary.rst
@@ -6,8 +6,10 @@ Formats: JSON, XML
 
 The API is able to return either XML or JSON, depending on the ‘Accept’ header in the request. By default a web browser will specify XML in the request. Note curl doesn’t specify any preference, so the API will respond with json.
 
-To ensure you get xml back then add an Accept header to your request::
+To ensure you get xml back, add an Accept header to your request::
 
    curl https://new.talks.ox.ac.uk/api/series/041a5cc6-d65a-4dec-967d-3adc5162cea3 -H "Accept: application/xml"
 
-TODO authentication on some endpoints
+For a more detailed example of the API in use, see the :ref:`JavaScript widget documentation <widget:widget-index>`.
+
+
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -23,7 +23,15 @@ User Guide
 Web Managers and Integrators
 ****************************
 
-:ref:`Using the Oxford Talks JavaScript Widget <widget:widget-index>`
+An example widget to get you started with embedding talks in your own webpages can be found here:
+
+`https://github.com/ox-it/talks.ox-js-widget <https://github.com/ox-it/talks.ox-js-widget>`_
+
+The widget uses JavaScript to write a table, list or calendar view of selected talks to an HTML page. You can specify the criteria to select the talks you want.
+
+* :ref:`Widget Documentation Overview <widget:widget-index>`
+* :ref:`Parameters Reference <widget:parameters>`
+
 
 ***********************
 Developer Documentation