feat: add GitHub workflows for documentation quality checks#9
Merged
Conversation
- Add check-dead-links.yml for automated broken link detection and fixing - Add check-documentation-quality.yml for duplicate content and formatting issues - Both workflows run every 6 hours and create PRs with automated fixes
- Remove backticks from example text in YAML strings - Properly indent PR body content in shell scripts
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Pull Request Overview
This PR adds two GitHub Actions workflows to automate documentation maintenance by detecting and fixing issues in markdown and MDX files.
- Introduces a scheduled "Check Documentation Quality" workflow for double headers, duplicate content, missing metadata, code block tags, and icon consistency.
- Adds a scheduled "Check Dead Links" workflow to scan and automatically correct internal and external broken links.
- Both workflows run every six hours (or manually), create a feature branch with fixes, and open a pull request with a summary of changes.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| .github/workflows/check-documentation-quality.yml | New workflow to auto-detect and apply fixes for documentation quality issues |
| .github/workflows/check-dead-links.yml | New workflow to scan and auto-fix broken internal and external links |
Comments suppressed due to low confidence (8)
.github/workflows/check-documentation-quality.yml:43
- The action reference is misspelled as "anthropics/claude-code-action"; it should be "anthropic/claude-code-action@beta" to correctly reference the official repository.
uses: anthropics/claude-code-action@beta
.github/workflows/check-documentation-quality.yml:43
- Pin this action to a specific stable version or commit SHA instead of the floating "beta" tag to ensure reproducibility and security.
uses: anthropics/claude-code-action@beta
.github/workflows/check-documentation-quality.yml:1
- Add a concurrency section (for example,
concurrency: \n group: check-documentation-quality) to prevent overlapping runs from creating conflicting branches.
name: Check Documentation Quality
.github/workflows/check-documentation-quality.yml:142
- [nitpick] The commit prefix "fix:" may not align with conventional commit guidelines for documentation updates; consider using "docs:" or "chore:" to clarify the scope.
git commit -m "fix: automated documentation quality improvements" \
.github/workflows/check-dead-links.yml:37
- The action reference is misspelled as "anthropics/claude-code-action"; it should be "anthropic/claude-code-action@beta" to correctly reference the official repository.
uses: anthropics/claude-code-action@beta
.github/workflows/check-dead-links.yml:37
- Pin this action to a specific stable version or commit SHA instead of the floating "beta" tag to ensure reproducibility and security.
uses: anthropics/claude-code-action@beta
.github/workflows/check-dead-links.yml:1
- Add a concurrency section (for example,
concurrency: \n group: check-dead-links) to prevent overlapping runs from creating conflicting branches.
name: Check Dead Links
.github/workflows/check-dead-links.yml:117
- [nitpick] The commit prefix "fix:" may be misleading for documentation maintenance; consider using "docs:" or "chore:" to better reflect the purpose.
git commit -m "fix: automated broken link fixes" \
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds two GitHub workflows that will help maintain documentation quality by automatically detecting and fixing common issues.
Added Workflows
1. Check Dead Links ()
2. Check Documentation Quality ()
Benefits
Requirements
These workflows require:
Testing
The workflows can be manually triggered from the Actions tab after merge.