CONTRIBUTING notes on documentation updates & schema generation

Author: softwareengineerprogrammer

CONTRIBUTING.rst

@@ -286,6 +286,28 @@ Once a version bump is merged into the main repository with a Pull Request, tags
 
     (venv) ➜  python-geophires-x git:(main) git push origin --tags
 
+
+Documentation Updates
+---------------------
+
+If a change includes new classes with parameters that should be included in documentation,
+add them to `get_parameter_sources in geophires_x_schema_generator <https://github.com/NREL/GEOPHIRES-X/blob/1f47d6207c4d1458b949ac2cc470b453951d27ac/src/geophires_x_schema_generator/__init__.py#L48-L75>`__.
+Then run `geophires_x_schema_generator/main.py <https://github.com/NREL/GEOPHIRES-X/blob/main/src/geophires_x_schema_generator/main.py>`__
+and commit the updated json schema files to source - `example <https://github.com/NREL/GEOPHIRES-X/pull/285/files#diff-3d85ef79807fc6c25a758a698fd3a7095750bd27ea52341700e1dad94885b5f6>`__.
+
+``geophires_x_schema_generator/main.py`` should also be run if new parameters are added to existing classes or changes are made to existing parameters.
+
+New classes may also be added to the appropriate module file in ``docs/reference``, i.e. `geophires_x.rst <https://github.com/NREL/GEOPHIRES-X/blob/8cf4ee9a2cc917f037ff06554c40698ef2591614/docs/reference/geophires_x.rst#L16-L15>`__
+
+Schema Files
+------------
+
+GEOPHIRES & HIP-RA schema files generated by ``geophires_x_schema_generator`` are in an `OpenAPI Specification <https://swagger.io/docs/specification/about/>`__-compatible format.
+These schema files can be used to build your own API or UI for GEOPHIRES.
+
+* `geophires-request.json <https://github.com/NREL/GEOPHIRES-X/blob/main/src/geophires_x_schema_generator/geophires-request.json>`__
+* `hip-ra-x-request.json <https://github.com/NREL/GEOPHIRES-X/blob/main/src/geophires_x_schema_generator/hip-ra-x-request.json>`__
+
 Tips
 ----