improve developer's notes

AdvancedPhotonSource · Oct 14, 2024 · 3c42edd · 3c42edd
1 parent 42b7663
commit 3c42edd
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 10 deletions.
diff --git a/webdocs/developers.rst b/webdocs/developers.rst
@@ -4,16 +4,38 @@
    :align: right
 
 ======================================
-Documentation for GSAS-II Developers
+Notes for GSAS-II Developers
 ======================================
 
-Note the `documentation web page <documentation.html>`_, as the
-"Developer's Documentation" document, available in several formats, is
-of very significant value for code development.  
+We welcome cooperation from people interested in developing or
+extending GSAS-II. The code is open source and we are happy to review
+submitted code or consider collaborations. The ideal mechanism for
+contributions is to clone the
+`GitHub repo <https://github.com/AdvancedPhotonSource/GSAS-II>`_ and
+then create a pull request, but small changes can be considered via
+e-mail.
+
+Note that you can have multiple copies of GSAS-II installed on your
+computer so that you can compare running a local development version
+against the latest distribution. See the web page on
+`Installing GSAS-II for code development <install_dev.html>`_ for more
+details. 
+
+The Sphinx documentation for the GSAS-II source code will be of
+significant value for people attempting to work their way through the
+codebase. This is found on the wonderful “Read The Docs” web
+site. These documents are available in a number of ways:
+
+* `Access online <https://gsas-ii.readthedocs.io>`_ (HTML)
+* `Download as a PDF document
+  <https://gsas-ii.readthedocs.io/_/downloads/en/latest/pdf/>`_ (~450 pages)
+* `Download as an electronic book
+  <https://gsas-ii.readthedocs.io/_/downloads/en/latest/epub/>`_ (Epub format). 
 
 If you use any of the self-installer options (gsas2full, gsas2pkg or gitstrap.py), GSAS-II will be installed using https from https://github.com/AdvancedPhotonSource/GSAS-II.git. This is fine for downloading, but to be able to write to the repository, you will probably need to switch to using ssh,
 the command for this is::
 
     git remote set-url origin [email protected]:AdvancedPhotonSource/GSAS-II.git
 
- 
+More on this is in the `Installing GSAS-II for code development <install_dev.html>`_ 
+web page, which discusses changing the origin to your forked copy of GSAS-II.
diff --git a/webdocs/index.rst b/webdocs/index.rst
@@ -121,7 +121,7 @@ ways to update GSAS-II, as discussed below.
 
    help.rst
 
-Documentation for GSAS-II Developers
+Notes for GSAS-II Developers
 ======================================
 
 We encourage you to improve GSAS-II or to use the code in your own

diff --git a/webdocs/misc.rst b/webdocs/misc.rst
@@ -16,11 +16,10 @@ In cooperation with the ACA, IUCr, ICDD, LANSCE and NCNR, we celebrated Bob Von
 
 Both pre-recorded videos and live talks were presented. All content was placed on
 the American Crystallographic Association's History Portal (via a special `YouTube playlist <https://www.youtube.com/playlist?list=PL9KqEkw6mD5kU1qfJPsScoZTpEnPZIq1E>`_.
-Also of note is a short (and fairly modest) autobiographical sketch about Bob's work can be found `in the ACA's History pages <https://history.amercrystalassn.org/robert-von-dreele>`_.
+Also of note is a short (and fairly modest) autobiographical sketch
+about Bob's work which can also be found `in the ACA's History Portal <https://history.amercrystalassn.org/robert-von-dreele>`_.
 
-Listing of Presentations
-
-.. list-table:: Title
+.. list-table:: VonDreeleFest Presentations 
    :widths: 15 60 15 10
    :header-rows: 1