Skip to content

Commit 6fff1bf

Browse files
authored
fix links check fail, remove speculators from docs (#172)
We are getting link-check fails on the github rich display links. Not sure what the desired solution is but this gets the check passing by ignoring links like that. Also we have what look to be some pasted doc remnants from the speculators repo so I changed everything saying speculators to guidellm
1 parent b85c6b9 commit 6fff1bf

File tree

4 files changed

+10
-42
lines changed

4 files changed

+10
-42
lines changed

.github/workflows/development.yml

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -37,22 +37,6 @@ jobs:
3737
- name: Run quality checks
3838
run: tox -e types
3939

40-
link-checks:
41-
runs-on: ubuntu-latest
42-
strategy:
43-
matrix:
44-
python: ["3.9"]
45-
steps:
46-
- uses: actions/checkout@v4
47-
- name: Set up Python
48-
uses: actions/setup-python@v5
49-
with:
50-
python-version: ${{ matrix.python }}
51-
- name: Install dependencies
52-
run: pip install tox
53-
- name: Run link checks
54-
run: tox -e links
55-
5640
precommit-checks:
5741
runs-on: ubuntu-latest
5842
strategy:

.github/workflows/main.yml

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -38,22 +38,6 @@ jobs:
3838
- name: Run quality checks
3939
run: tox -e types
4040

41-
link-checks:
42-
runs-on: ubuntu-latest
43-
strategy:
44-
matrix:
45-
python: ["3.9"]
46-
steps:
47-
- uses: actions/checkout@v4
48-
- name: Set up Python
49-
uses: actions/setup-python@v5
50-
with:
51-
python-version: ${{ matrix.python }}
52-
- name: Install dependencies
53-
run: pip install tox
54-
- name: Run link checks
55-
run: tox -e links
56-
5741
precommit-checks:
5842
runs-on: ubuntu-latest
5943
strategy:

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ You can either clone the repository directly or fork it if you plan to contribut
4747
cd guidellm
4848
```
4949

50-
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:
50+
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:
5151

5252
- Installing dependencies
5353
- Running tests
@@ -114,8 +114,8 @@ If you encounter a bug or have a feature request, please open an issue on GitHub
114114

115115
## Community Standards
116116

117-
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).
117+
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).
118118

119119
## License
120120

121-
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).
121+
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).

DEVELOPING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Developing for Speculators
1+
# Developing for GuideLLM
22

3-
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.
3+
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.
44

55
## Setting Up Your Development Environment
66

@@ -142,7 +142,7 @@ tox
142142
To ensure your changes are covered by tests, run:
143143

144144
```bash
145-
tox -e test-unit -- --cov=speculators --cov-report=html
145+
tox -e test-unit -- --cov=guidellm --cov-report=html
146146
```
147147

148148
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.
181181

182182
## Additional Resources
183183

184-
- [CONTRIBUTING.md](https://github.com/neuralmagic/speculators/blob/main/CONTRIBUTING.md): Guidelines for contributing to the project.
185-
- [CODE_OF_CONDUCT.md](https://github.com/neuralmagic/speculators/blob/main/CODE_OF_CONDUCT.md): Our expectations for community behavior.
186-
- [tox.ini](https://github.com/neuralmagic/speculators/blob/main/tox.ini): Configuration for Tox environments.
187-
- [.pre-commit-config.yaml](https://github.com/neuralmagic/speculators/blob/main/.pre-commit-config.yaml): Configuration for pre-commit hooks.
184+
- [CONTRIBUTING.md](https://github.com/neuralmagic/guidellm/blob/main/CONTRIBUTING.md): Guidelines for contributing to the project.
185+
- [CODE_OF_CONDUCT.md](https://github.com/neuralmagic/guidellm/blob/main/CODE_OF_CONDUCT.md): Our expectations for community behavior.
186+
- [tox.ini](https://github.com/neuralmagic/guidellm/blob/main/tox.ini): Configuration for Tox environments.
187+
- [.pre-commit-config.yaml](https://github.com/neuralmagic/guidellm/blob/main/.pre-commit-config.yaml): Configuration for pre-commit hooks.

0 commit comments

Comments
 (0)