From 1d5bd7365ca9a3ed1e6ee09999c24d76012f5bd2 Mon Sep 17 00:00:00 2001 From: dalthecow Date: Wed, 21 May 2025 14:08:02 -0400 Subject: [PATCH 1/4] remove speculators from docs --- CONTRIBUTING.md | 6 +++--- DEVELOPING.md | 14 +++++++------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5d3369b0..b9bfc717 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -47,7 +47,7 @@ You can either clone the repository directly or fork it if you plan to contribut cd guidellm ``` -For detailed instructions on setting up your development environment, please refer to the [DEVELOPING.md](https://github.com/neuralmagic/speculators/blob/main/DEVELOPING.md) file. It includes step-by-step guidance on: +For detailed instructions on setting up your development environment, please refer to the [DEVELOPING.md](https://github.com/neuralmagic/guidellm/blob/main/DEVELOPING.md) file. It includes step-by-step guidance on: - Installing dependencies - Running tests @@ -114,8 +114,8 @@ If you encounter a bug or have a feature request, please open an issue on GitHub ## Community Standards -We are committed to fostering a welcoming and inclusive community. Please read and adhere to our [Code of Conduct](https://github.com/neuralmagic/speculators/blob/main/CODE_OF_CONDUCT.md). +We are committed to fostering a welcoming and inclusive community. Please read and adhere to our [Code of Conduct](https://github.com/neuralmagic/guidellm/blob/main/CODE_OF_CONDUCT.md). ## License -By contributing to Speculators, you agree that your contributions will be licensed under the [Apache License 2.0](https://github.com/neuralmagic/speculators/blob/main/LICENSE). +By contributing to GuideLLM, you agree that your contributions will be licensed under the [Apache License 2.0](https://github.com/neuralmagic/guidellm/blob/main/LICENSE). diff --git a/DEVELOPING.md b/DEVELOPING.md index d91dc93d..074238e1 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -1,6 +1,6 @@ -# Developing for Speculators +# Developing for GuideLLM -Thank you for your interest in contributing to Speculators! This document provides detailed instructions for setting up your development environment, implementing changes, and adhering to the project's best practices. Your contributions help us grow and improve this project. +Thank you for your interest in contributing to GuideLLM! This document provides detailed instructions for setting up your development environment, implementing changes, and adhering to the project's best practices. Your contributions help us grow and improve this project. ## Setting Up Your Development Environment @@ -142,7 +142,7 @@ tox To ensure your changes are covered by tests, run: ```bash -tox -e test-unit -- --cov=speculators --cov-report=html +tox -e test-unit -- --cov=guidellm --cov-report=html ``` Review the coverage report to confirm that your new code is adequately tested. @@ -181,7 +181,7 @@ Review the coverage report to confirm that your new code is adequately tested. ## Additional Resources -- [CONTRIBUTING.md](https://github.com/neuralmagic/speculators/blob/main/CONTRIBUTING.md): Guidelines for contributing to the project. -- [CODE_OF_CONDUCT.md](https://github.com/neuralmagic/speculators/blob/main/CODE_OF_CONDUCT.md): Our expectations for community behavior. -- [tox.ini](https://github.com/neuralmagic/speculators/blob/main/tox.ini): Configuration for Tox environments. -- [.pre-commit-config.yaml](https://github.com/neuralmagic/speculators/blob/main/.pre-commit-config.yaml): Configuration for pre-commit hooks. +- [CONTRIBUTING.md](https://github.com/neuralmagic/guidellm/blob/main/CONTRIBUTING.md): Guidelines for contributing to the project. +- [CODE_OF_CONDUCT.md](https://github.com/neuralmagic/guidellm/blob/main/CODE_OF_CONDUCT.md): Our expectations for community behavior. +- [tox.ini](https://github.com/neuralmagic/guidellm/blob/main/tox.ini): Configuration for Tox environments. +- [.pre-commit-config.yaml](https://github.com/neuralmagic/guidellm/blob/main/.pre-commit-config.yaml): Configuration for pre-commit hooks. From 43fdeb085bd7694d0e6a6dd3c6d49e6beaea3891 Mon Sep 17 00:00:00 2001 From: dalthecow Date: Wed, 21 May 2025 14:25:27 -0400 Subject: [PATCH 2/4] update tox.ini to exclude github view files (blobs) that break the link check --- tox.ini | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tox.ini b/tox.ini index 08fc27b9..b5dd351d 100644 --- a/tox.ini +++ b/tox.ini @@ -66,8 +66,8 @@ description = Run link checks for root and docs markdown files deps = .[dev] commands = - mkdocs-linkcheck ./ - mkdocs-linkcheck docs/ + mkdocs-linkcheck ./ --exclude 'https://github\.com/.*/blob/.+\.md' + mkdocs-linkcheck docs/ --exclude 'https://github\.com/.*/blob/.+\.md' [testenv:build] From 1e29968ac74aec71f05d1d4fb29d25b61a3d4225 Mon Sep 17 00:00:00 2001 From: dalthecow Date: Wed, 21 May 2025 15:30:46 -0400 Subject: [PATCH 3/4] not to ignore more than markdown for rich display mode --- tox.ini | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tox.ini b/tox.ini index b5dd351d..131d6ac6 100644 --- a/tox.ini +++ b/tox.ini @@ -66,8 +66,8 @@ description = Run link checks for root and docs markdown files deps = .[dev] commands = - mkdocs-linkcheck ./ --exclude 'https://github\.com/.*/blob/.+\.md' - mkdocs-linkcheck docs/ --exclude 'https://github\.com/.*/blob/.+\.md' + mkdocs-linkcheck ./ --exclude 'https://github\.com/.*/blob/.*' + mkdocs-linkcheck docs/ --exclude 'https://github\.com/.*/blob/.*' [testenv:build] From 247d1cfe9a9b69669f22155def7879ad5ec676b4 Mon Sep 17 00:00:00 2001 From: dalthecow Date: Thu, 22 May 2025 11:24:13 -0400 Subject: [PATCH 4/4] undo alteration of link checks, instead remove from workflows temporarily --- .github/workflows/development.yml | 16 ---------------- .github/workflows/main.yml | 16 ---------------- tox.ini | 4 ++-- 3 files changed, 2 insertions(+), 34 deletions(-) diff --git a/.github/workflows/development.yml b/.github/workflows/development.yml index 3450c758..45e42bb3 100644 --- a/.github/workflows/development.yml +++ b/.github/workflows/development.yml @@ -37,22 +37,6 @@ jobs: - name: Run quality checks run: tox -e types - link-checks: - runs-on: ubuntu-latest - strategy: - matrix: - python: ["3.9"] - steps: - - uses: actions/checkout@v4 - - name: Set up Python - uses: actions/setup-python@v5 - with: - python-version: ${{ matrix.python }} - - name: Install dependencies - run: pip install tox - - name: Run link checks - run: tox -e links - precommit-checks: runs-on: ubuntu-latest strategy: diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index fcd0a515..b8bf7855 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -38,22 +38,6 @@ jobs: - name: Run quality checks run: tox -e types - link-checks: - runs-on: ubuntu-latest - strategy: - matrix: - python: ["3.9"] - steps: - - uses: actions/checkout@v4 - - name: Set up Python - uses: actions/setup-python@v5 - with: - python-version: ${{ matrix.python }} - - name: Install dependencies - run: pip install tox - - name: Run link checks - run: tox -e links - precommit-checks: runs-on: ubuntu-latest strategy: diff --git a/tox.ini b/tox.ini index 131d6ac6..08fc27b9 100644 --- a/tox.ini +++ b/tox.ini @@ -66,8 +66,8 @@ description = Run link checks for root and docs markdown files deps = .[dev] commands = - mkdocs-linkcheck ./ --exclude 'https://github\.com/.*/blob/.*' - mkdocs-linkcheck docs/ --exclude 'https://github\.com/.*/blob/.*' + mkdocs-linkcheck ./ + mkdocs-linkcheck docs/ [testenv:build]