docs: fix link error in README; fix lint errors in markdown files; add a CI to automatically check markdown quality#100
Conversation
|
@Phil-Fan Thank you for great contribution! Could you fix the lint check of Markdown, please? |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
sry, I put the configuration file into the wrong place now it can run correctly :) |
There was a problem hiding this comment.
Pull Request Overview
This PR improves documentation quality by fixing broken links, correcting file references, standardizing formatting across all markdown files, and introducing automated markdown quality checks via GitHub Actions.
- Fixed broken markdown links and incorrect file references throughout documentation
- Standardized markdown formatting (blank lines, indentation, image alt text)
- Added CI workflow to automatically check markdown quality using autocorrect and markdownlint
Reviewed Changes
Copilot reviewed 23 out of 25 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| examples/pd-disagg/sglang/sgl.md | Added blank lines for proper markdown formatting |
| examples/pd-disagg/dynamo/README.md | Added image alt text and blank lines for better formatting |
| doc/reference/variables.md | Fixed table alignment by removing trailing spaces |
| doc/reference/api.md | Fixed table alignment by removing trailing spaces |
| doc/quick_start.md | Added image alt text and improved section headers |
| doc/install.md | Added blank lines and fixed formatting inconsistencies |
| doc/features/update-strategy.md | Fixed code block indentation |
| doc/features/revision.md | Added blank lines for proper markdown formatting |
| doc/features/multiroles.md | Added image alt text |
| doc/features/monitoring.md | Fixed broken link syntax from ].( to ]( and improved list formatting |
| doc/features/kubectl-rbg.md | Added missing heading and improved section structure |
| doc/features/instance.md | Added image alt text and fixed trailing spaces |
| doc/features/gang-scheduling.md | Fixed incorrect example file references from gang-scheduling.yaml to correct scheduler-plugins-gang.yaml and volcano-gang.yaml |
| doc/features/failure-handling.md | Added image alt text |
| doc/features/exclusive-topology.md | Added blank line and removed trailing spaces |
| doc/features/autoscaler.md | Added image alt text and removed extra blank lines |
| doc/dev/how_to_release.md | Added proper heading structure and formatting |
| doc/dev/how_to_develop.md | Improved code block formatting and removed command prompt symbols |
| doc/TOC.md | Fixed indentation and updated gang-scheduling example link |
| README.md | Fixed link from doc/CONTRIBUTING.md to CONTRIBUTING.md and added image alt text |
| README-zh_CN.md | Fixed link to CONTRIBUTING.md and improved spacing in Chinese text |
| CONTRIBUTING.md | Fixed formatting and improved section headers |
| .github/workflows/docs-check.yml | Added new CI workflow for markdown quality checks |
| .github/pull_request_template.md | Removed extra blank lines |
| .github/.markdownlint.json | Added markdownlint configuration file |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 23 out of 25 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
|
/lgtm |
|
Thanks for this contribution! If you’re interested, please share your email so you can join us in the discussions and implementation of our project’s future work. @Phil-Fan |
My email is |
Ⅰ. Motivation
Hi, as a newcomer of this repo, I found there are some small issues in the document files, so I proposed this PR.
Ⅱ. Modifications
Ⅲ. Does this pull request fix one issue?
fixes #99
Ⅳ. List the added test cases (unit test/integration test) if any, please explain if no tests are needed.
Ⅴ. Describe how to verify it
VI. Special notes for reviews
Checklist
make fmt.( I haven't change any code)