Enhance GuideLLM Documentation and Setup (#21)

## Summary
This pull request introduces significant enhancements to the GuideLLM
project documentation and setup processes. The updates aim to provide
clear guidance to contributors, improve project accessibility, and
enforce markdown formatting standards.

## Changes Made
- **README.md**: Added a comprehensive README with project overview, key
features, installation instructions, quick start guide, and advanced
settings. Updated to include badges, images, and structured
documentation links for better navigation.
- **Markdown Formatting**: Implemented markdown formatting checks using
`mdformat` to enforce consistent documentation standards across the
project.
- **Pyproject.toml and Tox Configuration**: Updated configurations to
include documentation quality checks, ensuring markdown files adhere to
best practices.

## Test Plan
- Verified that all markdown files comply with the formatting standards
set by `mdformat`.
- Conducted manual testing to ensure links and images render correctly
in the README and other markdown documents.
- Ran unit tests to confirm that existing functionality remains
unaffected by documentation updates.

---------

Co-authored-by: Mark Kurtz <mark.kurtz@neuralmagic.com>

Author: rgreenberg1

.mdformat.toml

@@ -0,0 +1,3 @@
+wrap = "no"
+number = true
+end_of_line = "lf"

CODE_OF_CONDUCT.md

@@ -1,92 +1,47 @@
-<!--
-Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-   http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
--->
-
 # Community Code of Conduct
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to make participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
 
 ## Our Standards
 
-Examples of behavior that contributes to creating a positive environment
-include:
+Examples of behavior that contributes to creating a positive environment include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Our Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
 
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
 
 ## Scope
 
-This Code of Conduct applies within all project spaces, and it also applies when
-an individual is representing the project or its community in public spaces.
-Examples of representing a project or community include using an official
-project e-mail address, posting via an official social media account, or acting
-as an appointed representative at an online or offline event. Representation of
-a project may be further defined and clarified by project maintainers.
+This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team using the [Neural Magic Contact Us Form](https://neuralmagic.com/contact). All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team using the [Neural Magic Contact Us Form](https://neuralmagic.com/contact). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
 
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
 
-[homepage]: https://www.contributor-covenant.org
+For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq
 
-For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
+[homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

@@ -1,19 +1,3 @@
-<!--
-Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-   http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
--->
-
 # Contributing to GuideLLM
 
 If you’re reading this, hopefully we have piqued your interest to take the next step. Join us and help make GuideLLM even better! As a contributor, here are some community guidelines we would like you to follow:

DEVELOPING.md

@@ -2,8 +2,7 @@
 
 ## Introduction
 
-Welcome to the developer documentation for `guidellm`, a guidance platform for evaluating large language model deployments.
-This document aims to provide developers with all the necessary information to contribute to the project effectively.
+Welcome to the developer documentation for `guidellm`, a guidance platform for evaluating large language model deployments. This document aims to provide developers with all the necessary information to contribute to the project effectively.
 
 ## Getting Started
 
@@ -25,6 +24,7 @@ Before you begin, ensure you have the following installed:
    ```
 
 2. Install the required dependencies:
+
    ```bash
    pip install -e .[dev]
    ```
@@ -60,6 +60,7 @@ To set up your development environment, follow these steps:
    ```
 
 2. Ensure all dependencies are installed:
+
    ```bash
    pip install -e .[dev]
    ```
@@ -120,35 +121,31 @@ To run all tests:
 tox
 ```
 
-Additionally, all tests are marked with smoke, sanity, or regression tags for better organization.
-To run tests with a specific tag, use the `-m` flag:
+Additionally, all tests are marked with smoke, sanity, or regression tags for better organization. To run tests with a specific tag, use the `-m` flag:
 
 ```bash
 tox -- -m "smoke or sanity"
 ```
 
 ### Running Unit Tests
 
-The unit tests are located in the `tests/unit` directory.
-To run the unit tests, use the following command:
+The unit tests are located in the `tests/unit` directory. To run the unit tests, use the following command:
 
 ```bash
 tox -e test-unit
 ```
 
 ### Running Integration Tests
 
-The integration tests are located in the `tests/integration` directory.
-To run the integration tests, use the following command:
+The integration tests are located in the `tests/integration` directory. To run the integration tests, use the following command:
 
 ```bash
 tox -e test-integration
 ```
 
 ### Running End-to-End Tests
 
-The end-to-end tests are located in the `tests/e2e` directory.
-To run the end-to-end tests, use the following command:
+The end-to-end tests are located in the `tests/e2e` directory. To run the end-to-end tests, use the following command:
 
 ```bash
 tox -e test-e2e
@@ -198,9 +195,7 @@ tox -e clean
 
 ## Continuous Integration/Continuous Deployment (CI/CD)
 
-Our CI/CD pipeline is configured using GitHub Actions.
-The configuration files are located in the .github/workflows/ directory.
-You can run the CI/CD pipeline locally using act or similar tools.
+Our CI/CD pipeline is configured using GitHub Actions. The configuration files are located in the .github/workflows/ directory. You can run the CI/CD pipeline locally using act or similar tools.
 
 ## Contributing