minor grammatical changes and rewording of text

cadenmyers13 · cadenmyers13 · commit 23d869268f50 · 2025-11-11T23:28:19.000-05:00
diff --git a/.github/ISSUE_TEMPLATE/new_pack_proposal.md b/.github/ISSUE_TEMPLATE/new_pack_proposal.md
@@ -17,6 +17,7 @@ assignees: ""
 - [ ] (OPTIONAL) Create a directory to place your examples, if applicable, by running `mkdir docs/examples/<your-pack-name>/<your-example-name>`.
 - [ ] (OPTIONAL) Copy your example scripts and data under the directory you just made. If you have multiple examples, house them under their own separate directory (i.e. `.../<your-pack-name>/example1` and `.../<your-pack-name>/example2`).
 - [ ] List your pack and its dependencies under `docs/source/available-packs.rst` using the same format as the other packs. In this same file, add a description of your pack (1-2 sentences is recommended).
+- [ ] Give yourself credit by listing your name and contributors to the pack you've created!
 
 ## Local testing
 
diff --git a/.github/ISSUE_TEMPLATE/new_profile_proposal.md b/.github/ISSUE_TEMPLATE/new_profile_proposal.md
@@ -11,6 +11,7 @@ assignees: ""
 - [ ] Fork and clone this repository and cd to the top level by running `cd diffpy.cmi`.
 - [ ] Create a requirements file by running `touch requirements/profiles/<your-profile-name>.yml`. List all packs used in this profile under the header `packs:` in a bulleted list. All additional packages used (if any) should be listed under `extras:` in a similar fashion (see [this file](https://github.com/diffpy/diffpy.cmi/blob/main/requirements/profiles/all.yml) for reference). If no additional packages are required, add the `extras:` header but leave the entries empty.
 - [ ] List your profile and its dependencies under `docs/source/available-profiles.rst` using the same format as the other profiles. In this same file, add a description of your profile (1-2 sentences is recommended).
+- [ ] Give yourself credit by listing your name and contributors to the profile you've created!
 
 ## Local testing
 
diff --git a/docs/source/available-packs.rst b/docs/source/available-packs.rst
@@ -10,6 +10,8 @@ core
 
 The ``core`` pack provides the essential building blocks for creating and running regression workflows in ``diffpy.cmi``.
 
+This pack was created by members of the Billinge Group and the DiffPy community.
+
 - ``packaging``
 - ``PyYAML``
 - ``diffpy.utils``
@@ -22,6 +24,8 @@ pdf
 
 The ``pdf`` pack is designed to handle pair distribution function (PDF) modeling and analysis.
 
+This pack was created by members of the Billinge Group and the DiffPy community.
+
 - ``diffpy.srreal``
 - ``pyobjcryst``
 
diff --git a/docs/source/available-profiles.rst b/docs/source/available-profiles.rst
@@ -9,6 +9,8 @@ pdf-plus
 
 A comprehensive pair distribution function profile that includes plotting and Jupyter Notebook support.
 
+This pack was created by members of the Billinge Group and the DiffPy community.
+
 packs: ``core``, ``pdf``, ``plotting``
 
 extras: ``ipykernel``
diff --git a/docs/source/cli-commands.rst b/docs/source/cli-commands.rst
@@ -2,6 +2,8 @@
 
 .. index:: cli-commands
 
+.. _cli-commands:
+
 CMI Command-Line Interface (CLI)
 --------------------------------
 
diff --git a/docs/source/img/CMI-logo.png b/docs/source/img/CMI-logo.png
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -8,35 +8,50 @@
 
 ``diffpy.cmi`` - Complex modeling infrastructure: a modular framework for multi-modal modeling of scientific data.
 
-diffpy.cmi is designed as an extensible complex modeling infrastructure. Users and developers can readily integrate novel data types and constraints into custom workflows. While widely used for advanced analysis of structural data, the framework is general and can be applied to any problem where model parameters are refined to fit calculated quantities to data.
+``diffpy.cmi`` is designed as an extensible complex modeling infrastructure.
+Users and developers can readily integrate novel data types and constraints into custom workflows.
+While widely used for advanced analysis of structural data, the framework is general and can be applied to any problem where
+model parameters are refined to fit data.
 
-diffpy.cmi is a community-driven project that supports Unix, Linux, macOS, and Windows platforms. It is designed to be used in Python scripts enabling flexible scripting and automation for advanced and reproducible workflows. Users are encouraged to leverage the software for their modeling needs and to contribute feedback, use cases, and extensions through the project community.
+``diffpy.cmi`` is a community-driven project that supports Unix, Linux, macOS, and Windows platforms.
+It is designed to be used in Python scripts enabling flexible scripting and automation for advanced and reproducible workflows.
+Users are encouraged to leverage the software for their modeling needs and to contribute feedback,
+use cases, and extensions through the project community.
 
 .. image:: ./img/diffpycmi_screenshot.png
     :alt: codecov-in-pr-comment
     :width: 600px
     :align: center
 
 =======================================
-Community Use and Extensible Modeling
+The power of diffpy.cmi
 =======================================
 
-One of the key strengths of ``diffpy.cmi`` is its modular design, which allows the integration and fitting of *any* data type, not just PDFs.
-While its most commonly used functionality is in PDF modeling and multi-dataset fitting, **we actively encourage and support community-developed modules and workflows for any data types you see fit!**
+``diffpy.cmi`` is designed to be a **generalized regression engine** for any data type, enabling researchers to fit, analyze, and combine multiple sources of information in a unified framework.
+
+.. raw:: html
+
+    <div style="border: 4px solid #555; border-radius: 8px; padding: 10px; margin: 1em 0; text-align: center; background-color: #f8f8f8;">
+        <strong>diffpy.cmi can be used to fit ANY type of data!</strong>
+    </div>
+
+One of the key strengths of ``diffpy.cmi`` is its modular design, which allows the integration and fitting of *any* data type.
+While its most commonly used functionality is in pair distribution function (PDF) modeling and multi-dataset fitting,
+**we actively encourage and support community-developed modules and workflows for any data types you see fit!**
 
 .. image:: ./img/cmi_problem_types.png
     :alt: codecov-in-pr-comment
     :width: 500px
     :align: center
 
-To make ``diffpy.cmi`` easy to use and easy to contribute to, we've developed the concepts of **Packs** and **Profiles**.
-Please see below for more information on these concepts and how you can contribute your own extensions to the community!
+To make ``diffpy.cmi`` easy to use, we organize functionality into **Packs** and **Profiles**, allowing users to contribute their own modules and workflows seamlessly.
+Please see the :ref:`overview <overview>` for more information on these concepts and how you can contribute your own extensions to the community!
 
 ===============
 Getting started
 ===============
 
-To get started, please visit the :ref:`Getting started <installation>` page.
+To get started, please visit the :ref:`Getting started <installation>` section.
 
 
 .. image:: ./img/pdfprimer.png
@@ -63,7 +78,7 @@ https://github.com/diffpy/diffpy.cmi/graphs/contributors.
 Installation
 ============
 
-See the `README <https://github.com/diffpy/diffpy.cmi#installation>`_
+See the :ref:`installation` page or the `README <https://github.com/diffpy/diffpy.cmi#installation>`_
 file included with the distribution.
 
 ================
diff --git a/docs/source/overview.rst b/docs/source/overview.rst
@@ -1,38 +1,26 @@
+
+.. _overview:
+
 Overview
 ===========
 
-``diffpy.cmi`` is designed as an extensible complex modeling infrastructure. Users and developers can readily integrate novel data types and constraints into custom workflows. While widely used for advanced analysis of structural data, the framework is general and can be applied to any problem where model parameters are refined to fit calculated quantities to data.
+``diffpy.cmi`` is designed as an extensible complex modeling infrastructure.
+Users and developers can readily integrate novel data types and constraints into custom workflows.
+While widely used for advanced analysis of structural data, the framework is general and can be applied to any problem where
+model parameters are refined to fit data.
 
-``diffpy.cmi`` is a community-driven project that supports Unix, Linux, macOS, and Windows platforms. It is designed to be used in Python scripts enabling flexible scripting and automation for advanced and reproducible workflows. Users are encouraged to leverage the software for their modeling needs and to contribute feedback, use cases, and extensions through the project community.
+``diffpy.cmi`` is a community-driven project that supports Unix, Linux, macOS, and Windows platforms.
+It is designed to be used in Python scripts enabling flexible scripting and automation for advanced and reproducible workflows.
+Users are encouraged to leverage the software for their modeling needs and to contribute feedback,
+use cases, and extensions through the project community.
 
-.. image:: ./img/diffpycmi_screenshot.png
+.. image:: ./img/CMI-logo.png
     :alt: codecov-in-pr-comment
     :width: 600px
     :align: center
 
-
-
-===========================
-The power of diffpy.cmi
-===========================
-
-``diffpy.cmi`` is designed to be a **generalized regression engine** for any data type, enabling researchers to fit, analyze, and combine multiple sources of information in a unified framework.
-
-.. raw:: html
-
-    <div style="border: 4px solid #555; border-radius: 8px; padding: 10px; margin: 1em 0; text-align: center; background-color: #f8f8f8;">
-        <strong>diffpy.cmi can be used to fit ANY type of data!</strong>
-    </div>
-
-While its most commonly used functionality is in atomic pair distribution function (PDF) modeling and multi-dataset fitting,
-**we actively encourage and support community-developed modules and workflows for any data types you see fit!**
-
-.. image:: ./img/cmi_problem_types.png
-    :alt: codecov-in-pr-comment
-    :width: 500px
-    :align: center
-
-To make ``diffpy.cmi`` easy to use, we organize functionality into **Packs** and **Profiles**, allowing users to contribute their own modules and workflows seamlessly.
+To make ``diffpy.cmi`` easy to use, we organize functionality into **Packs** and **Profiles**,
+allowing users to contribute their own modules and workflows seamlessly.
 
 .. _whats-a-pack:
 
@@ -60,32 +48,34 @@ How to contribute a Pack
 -------------------------
 
 Have you built a new workflow you'd like to implement into ``diffpy.cmi``?
-We would love to **highlight your extension or application!**
+We would love to **highlight it here!**
 To share your work with the community, we ask you to follow these simple steps:
 
 1. **Open an Issue:** Navigate to the ``diffpy.cmi`` `issues page <https://github.com/diffpy/diffpy.cmi/issues>`_ on GitHub and click :guilabel:`New Issue`.
-   Select the "New Pack Proposal" template. Fill out the template with the required fields and open the issue.
+   Select the "New Pack Proposal" template. Fill out the template with the name of your pack and open the issue.
 
 .. image:: ./img/issue_template.png
     :alt: codecov-in-pr-comment
     :width: 500px
     :align: center
 
-2. **Create a Pull Request:** Address all prompts and questions in the issue thread.
-   Once all questions are answered and the pack is ready to be added to ``diffpy.cmi``,
+1. **Create a Pull Request:** Address all prompts in the issue thread and check all boxes.
+   Once everything is complete and the pack is ready to be added to ``diffpy.cmi``,
    `create a pull request <https://github.com/diffpy/diffpy.cmi>`_  (PR) linking to the issue.
    The PR will be reviewed by the maintainers and merged once approved.
-3. **Be recognized:** Community contributions and new use cases will be showcased and credited here.
+2. **Be recognized:** Make sure to add your pack to the list of available packs in the documentation!
+   Community contributions and new use cases will be showcased and credited here.
 
 ===================
 What's a Profile?
 ===================
 
-A **profile** is a pre-configured modeling workflow for a specific data type or analysis task within the ``diffpy.cmi`` framework.
-Profiles are designed to streamline the modeling process by providing users with ready-to-use configurations that can be easily
-adapted to their specific needs. Profiles are designed to be simpler than packs, as they do not require any new code development.
+A **profile** is a pre-configured compilation of packs and packages for a specific data type or analysis task within the ``diffpy.cmi`` framework.
+Profiles are designed to be easily installable configurations that bundle multiple packs and any additional dependencies
+required for a particular modeling task.
 
-For example, the profile ``all`` contains the ``plotting`` and ``pdf`` packs. Additionally, it contains the package ``ipykernel`` to enable Jupyter Notebook support.
+For example, the profile ``pdf-plus`` contains the ``plotting`` and ``pdf`` packs.
+Additionally, it contains the package ``ipykernel`` to enable Jupyter Notebook support.
 
 Why Profiles?
 -------------------
@@ -96,20 +86,21 @@ Running a simple command ``cmi install <profile_name>`` will install all necessa
 How to contribute a Profile
 ---------------------------
 
-Have you built a new modeling workflow that you'd like to share with the community?
-We would love to **highlight your extension or application!**
+Have you built a profile that you'd like to share with the community?
+We would love to **highlight it here!**
 To share your work with the community, we ask you to follow these simple steps:
 
 1. **Open an Issue:** Navigate to the ``diffpy.cmi`` `issues page <https://github.com/diffpy/diffpy.cmi/issues>`_ on GitHub and click :guilabel:`New Issue`.
-   Select the "New Profile Proposal" template. Fill out the template with the required fields and open the issue.
+   Select the "New Profile Proposal" template. Fill out the template with the name of your profile and open the issue.
 
 .. image:: ./img/issue_template.png
     :alt: codecov-in-pr-comment
     :width: 500px
     :align: center
 
-2. **Create a Pull Request:** Address all prompts and questions in the issue thread.
-   Once all questions are answered and the profile is ready to be added to ``diffpy.cmi``,
+2. **Create a Pull Request:** Address all prompts in the issue thread and check all boxes.
+   Once everything is complete and the profile is ready to be added to ``diffpy.cmi``,
    `create a pull request <https://github.com/diffpy/diffpy.cmi>`_  (PR) linking to the issue.
    The PR will be reviewed by the maintainers and merged once approved.
-3. **Be recognized:** Community contributions and new use cases will be showcased and credited here.
+3. **Be recognized:** Make sure to add your profile to the list of available profiles in the documentation!
+   Community contributions and new use cases will be showcased and credited here.
diff --git a/news/cli-docs.rst b/news/cli-docs.rst
@@ -1,6 +1,6 @@
 **Added:**
 
-* Added comprehensive documentation highlighting new cli changes.
+* Add comprehensive documentation highlighting new cli changes.
 
 **Changed:**
 
