Merge pull request #107 from usnistgov/104-restructure-docs-along-dia…

…taxis-framework 104 restructure docs along diataxis frameworkv2
usnistgov · Oct 2, 2023 · 52aee5a · 52aee5a
2 parents f15b8df + 5851f2b
commit 52aee5a
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 11 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -36,11 +36,12 @@ from raw data to an analysis with clear commands, punch down to the data you nee
 quickly. The goal is for these tools to make the mechanics of hyperspectral scattering easier and 
 in so doing, more reproducible, explainable, and robust.
 
-PyHyperScattering is a product of the `National Institute of Standards and Technology (NIST) 
-<https://www.nist.gov/>`_. This package is under active development, and the team welcome DMs 
-with questions on the NIST RSoXS slack, Nikea, and NSLS2 slack channels, or by email to 
-`Dr. Peter Beaucage <mailto:peter.beaucage@nist.gov>`_. For more information about contributing, 
-development philosophy, and licensing, see :ref:`the Development page <Development>`.
+PyHyperScattering is an open-source collaboration maintained by the `National Institute of 
+Standards and Technology (NIST) <https://www.nist.gov/>`_. This package is under active 
+development, and the team welcome DMs with questions on the NIST RSoXS slack, Nikea, and NSLS2 slack 
+channels, or by email to `Dr. Peter Beaucage <mailto:peter.beaucage@nist.gov>`_. 
+For more information about contributing, development philosophy, and licensing, 
+see :ref:`the Development page <Development>`.
 
 Documentation
 -------------

diff --git a/docs/source/development/idx_development.rst b/docs/source/development/idx_development.rst
@@ -3,11 +3,11 @@
 Development and Contributing Info: TODO
 ==============================================================
 
-PyHyperScattering is a product of the `National Institute of Standards and Technology (NIST) 
-<https://www.nist.gov/>`_. This package is under active development, and the team welcome DMs 
-with questions on the NIST RSoXS slack, Nikea, and NSLS2 slack channels, or by email to 
-`Dr. Peter Beaucage <mailto:peter.beaucage@nist.gov>`_. For more information about contributing, 
-development philosophy, and licensing, see :ref:`the Development page <Development>`.
+PyHyperScattering is an open-source collaboration maintained by the `National Institute of 
+Standards and Technology (NIST) <https://www.nist.gov/>`_. This package is under active 
+development, and the team welcome DMs with questions on the NIST RSoXS slack, Nikea, and NSLS2 slack 
+channels, or by email to `Dr. Peter Beaucage <mailto:peter.beaucage@nist.gov>`_. For more information 
+about contributing, development philosophy, and licensing, see :ref:`the Development page <Development>`.
 
 
 Scope and Package Outline
@@ -16,7 +16,7 @@ TODO
 
 Contributing
 ------------
-Contributions are welcome! Please view our `Contributer Guidelines <https://github.com/usnistgov/PyHyperScattering/blob/main/CONTRIBUTING.md>`_ on github.
+Contributions are welcome! Please view our `Contributor Guidelines <https://github.com/usnistgov/PyHyperScattering/blob/main/CONTRIBUTING.md>`_ on github.
 
 License
 -------

diff --git a/docs/source/release_notes/idx_release_notes.rst b/docs/source/release_notes/idx_release_notes.rst
@@ -3,4 +3,8 @@
 Release Notes
 =================
 
+Release notes for each release are on the `GitHub releases page <https://github.com/usnistgov/PyHyperScattering/releases>`
+
+Major changes are discussed here:
+
 Preparing for v1.0 release, which includes breaking changes that make xarray Datasets the underlying data structure.