Update docs for consistency with other languages

ampl · Feb 15, 2023 · 208ea20 · 208ea20
1 parent 363bf72
commit 208ea20
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 23 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -49,7 +49,7 @@
 # The short X.Y version.
 version = "2.0"
 # The full version, including alpha/beta/rc tags.
-release = '2.0.11.0-20220823'
+release = "2.0.11.0-20220823"
 
 
 # The language for content autogenerated by Sphinx. Refer to documentation
@@ -104,22 +104,10 @@
         },
         {
             "name": "AMPL Resources",
-            "url": "https://developers.ampl.com",
+            "url": "https://dev.ampl.com",
             "icon": "fas fa-book fa-fw",
             "target": "_self",
         },
-        {
-            "name": "AMPL Portal",
-            "url": "https://portal.ampl.com",
-            "icon": "fas fa-sign-in-alt fa-fw",
-            "target": "_self",
-        },
-        {
-            "name": "AMPL.com",
-            "url": "https://ampl.com",
-            "icon": "fas fa-home fa-fw",
-            "target": "_self",
-        },
     ],
     "collapse_navigation": True,
     "logo_text": "R API",

diff --git a/docs/source/examples.rst b/docs/source/examples.rst
@@ -1,7 +1,7 @@
 .. _secExamplesR:
 
-R API examples
-===================
+R API Examples
+==============
 
 This section lists a few examples in R.
 These are the same files that can be found in the *examples* directory of the

diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst
@@ -1,7 +1,7 @@
 .. lblGettingStarted:
 
-Getting started
-===============
+Initial Setup
+=============
 
 Installation
 ------------

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -8,11 +8,16 @@ AMPL R API
 ``rAMPL`` is an interface that allows developers to access the features of `AMPL <https://ampl.com>`_ from within R.
 For a quick introduction to AMPL see `Quick Introduction to AMPL <https://dev.ampl.com/ampl/introduction.html>`_.
 
+In the same way that AMPL's syntax matches naturally the mathematical description of the model,
+the input and output data matches naturally R data types such as vectors and dataframes.
+
 All model generation and solver interaction is handled directly by AMPL, which leads to
 great stability and speed; the library just acts as an intermediary, and the added overhead (in terms of memory and
 CPU usage) depends mostly on how much data is sent and read back from AMPL, the size of the expanded model as such is irrelevant.
+
 With ``rAMPL`` you can model and solve large scale optimization problems in R with the performance of heavily optimized C code
-without losing model readability.
+without losing model readability. The same model can be deployed on applications
+built on different languages by just switching the API used.
 
 Contents
 --------
@@ -22,7 +27,7 @@ Contents
 
    intro
    getting-started
-   class-structure
    quick-start
+   class-structure
    reference
    examples
diff --git a/docs/source/quick-start.rst b/docs/source/quick-start.rst
@@ -1,7 +1,7 @@
 .. _secRQuickStart:
 
-R quick start
-==================
+Quick Start
+===========
 
 This section will show a simple example to illustrate various functionalities of the AMPL R interface.
 The full example prints the version of the AMPL interpreter used, loads a model from file and the corresponding

diff --git a/docs/source/reference.rst b/docs/source/reference.rst
@@ -1,6 +1,6 @@
 .. _secReferenceR:
 
-R API reference
+R API Reference
 ===============
 
 AMPL classes