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.
Added drafts of README and GuideLLM CLI guide, still more to do, but got a rough outline in place. we can also discuss again what should live where in regards to the Using GuideLLM sections and such.
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
mdformat
to enforce consistent documentation standards across the project.Test Plan
mdformat
.