Skip to content

Conversation

@markurtz
Copy link
Collaborator

@markurtz markurtz commented May 1, 2025

Fixes: #139

…own files to latest standards for dev/community
@markurtz markurtz requested a review from Copilot May 1, 2025 15:38
@markurtz markurtz self-assigned this May 1, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates documentation links to use the correct GitHub URL format, introduces a CI/CD job for automated link checking, and refreshes markdown files to meet the latest standards for both developers and the community.

  • Updated dependency management in pyproject.toml to add link checking support.
  • Revised documentation files (README.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, DEVELOPING.md) for improved clarity and consistency.
  • Added new "link-checks" jobs across multiple GitHub workflow files to automate link validation.

Reviewed Changes

Copilot reviewed 10 out of 11 changed files in this pull request and generated no comments.

Show a summary per file
File Description
pyproject.toml Adds "mkdocs-linkcheck" dependency for link checking support in the development environment.
README.md Updates documentation hyperlinks from tree paths to blob paths for direct file access.
DEVELOPING.md Reorganizes development instructions; however, note the project name inconsistency.
CONTRIBUTING.md Refreshes contributing guidelines for clarity and updated process description.
CODE_OF_CONDUCT.md Updates Code of Conduct text and enforcement guidelines based on the latest standards.
.github/workflows/*.yml Introduces new "link-checks" jobs and adjusts Python versions in test matrices.
Files not reviewed (1)
  • tox.ini: Language not supported
Comments suppressed due to low confidence (2)

DEVELOPING.md:1

  • [nitpick] The project name 'Speculators' appears in DEVELOPING.md, which is inconsistent with 'GuideLLM' used in other documentation files. Consider updating this to 'GuideLLM' for consistency.
# Developing for Speculators

.github/workflows/main.yml:61

  • The precommit-checks job now uses a reduced Python matrix (only '3.9'), whereas previously a broader range was used. Verify that this change is intentional to maintain the desired test coverage across supported Python versions.
python: ["3.9"]

@nm-red-hat-upstream-automation-bot

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/14778269838/artifacts/3045154777.
They will be retained for up to 30 days.

@nm-red-hat-upstream-automation-bot

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/14778774703/artifacts/3045333431.
They will be retained for up to 30 days.

@markurtz markurtz merged commit 018e200 into main May 2, 2025
11 checks passed
@markurtz markurtz deleted the docs-fixes branch May 2, 2025 15:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

broken link in the docs

3 participants