Skip to content

Commit fb4c4e6

Browse files
committed
fix: correct YAML syntax in workflow files
- Remove backticks from example text in YAML strings - Properly indent PR body content in shell scripts
1 parent e30522d commit fb4c4e6

File tree

2 files changed

+39
-39
lines changed

2 files changed

+39
-39
lines changed

β€Ž.github/workflows/check-dead-links.ymlβ€Ž

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@ jobs:
4545
**Instructions:**
4646
1. Scan all MDX and MD files in the repository
4747
2. Check for the following types of links:
48-
- Internal relative links (e.g., `/components/cards`, `../guides/intro`)
49-
- External links (e.g., `https://example.com`)
50-
- Anchor links (e.g., `#section-name`)
48+
- Internal relative links (e.g., /components/cards, ../guides/intro)
49+
- External links (e.g., https://example.com)
50+
- Anchor links (e.g., #section-name)
5151
5252
**For each broken link found, automatically apply the fix:**
5353
- **For typos**: Correct the spelling/path
@@ -66,7 +66,7 @@ jobs:
6666
6767
**Link Checking Rules:**
6868
- Internal links should point to existing files
69-
- Internal links should use relative paths starting from root (e.g., `/api/reference`)
69+
- Internal links should use relative paths starting from root (e.g., /api/reference)
7070
- External links should return valid HTTP responses (not 404, 500, etc.)
7171
- Skip checking localhost links
7272
- Skip checking example.com or placeholder domains
@@ -132,27 +132,27 @@ jobs:
132132
# Create PR description with details from Claude's analysis
133133
PR_BODY="## Automated Broken Link Fixes
134134
135-
This PR contains automated fixes for broken links detected by the scheduled workflow.
135+
This PR contains automated fixes for broken links detected by the scheduled workflow.
136136
137-
### Changes Made:
138-
- πŸ”— Fixed internal broken links
139-
- πŸ“ Updated references to moved/renamed files
140-
- 🌐 Resolved external link issues
141-
- ✏️ Corrected typos in link paths
142-
- πŸ’­ Added comments for links requiring manual review
137+
### Changes Made:
138+
- πŸ”— Fixed internal broken links
139+
- πŸ“ Updated references to moved/renamed files
140+
- 🌐 Resolved external link issues
141+
- ✏️ Corrected typos in link paths
142+
- πŸ’­ Added comments for links requiring manual review
143143
144-
### Review Instructions:
145-
Please review the changes to ensure:
146-
1. All link fixes point to valid destinations
147-
2. Link text remains appropriate for new URLs
148-
3. Commented links are addressed appropriately
149-
4. No content meaning was changed
144+
### Review Instructions:
145+
Please review the changes to ensure:
146+
1. All link fixes point to valid destinations
147+
2. Link text remains appropriate for new URLs
148+
3. Commented links are addressed appropriately
149+
4. No content meaning was changed
150150
151-
### Files Modified:
152-
Check the Files changed tab for a complete list of modifications.
151+
### Files Modified:
152+
Check the Files changed tab for a complete list of modifications.
153153
154-
---
155-
*This PR was automatically generated by the dead links checker workflow.*"
154+
---
155+
*This PR was automatically generated by the dead links checker workflow.*"
156156
157157
# Create the PR using GitHub CLI
158158
gh pr create \

β€Ž.github/workflows/check-documentation-quality.ymlβ€Ž

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ jobs:
5151
**Quality Checks to Perform:**
5252
5353
1. **Double Header Issues:**
54-
- Find MDX files that have YAML frontmatter with a `title` field AND also have an H1 heading (`# Title`) in the content
54+
- Find MDX files that have YAML frontmatter with a title field AND also have an H1 heading (# Title) in the content
5555
- This creates duplicate headers because Mintlify automatically generates an H1 from the frontmatter title
5656
- This is a critical issue that affects page appearance and SEO
5757
@@ -157,27 +157,27 @@ jobs:
157157
# Create PR description with details from Claude's analysis
158158
PR_BODY="## Automated Documentation Quality Fixes
159159
160-
This PR contains automated fixes for documentation quality issues detected by the scheduled workflow.
160+
This PR contains automated fixes for documentation quality issues detected by the scheduled workflow.
161161
162-
### Changes Made:
163-
- πŸ”§ Fixed double header issues (H1 headings after frontmatter titles)
164-
- πŸ“ Resolved duplicate content across files
165-
- πŸ’» Added missing language tags to code blocks
166-
- 🎨 Replaced emojis with Mintlify icons
167-
- πŸ“Š Fixed heading hierarchy issues
162+
### Changes Made:
163+
- πŸ”§ Fixed double header issues (H1 headings after frontmatter titles)
164+
- πŸ“ Resolved duplicate content across files
165+
- πŸ’» Added missing language tags to code blocks
166+
- 🎨 Replaced emojis with Mintlify icons
167+
- πŸ“Š Fixed heading hierarchy issues
168168
169-
### Files Modified:
170-
Check the Files changed tab for a complete list of modifications.
169+
### Files Modified:
170+
Check the Files changed tab for a complete list of modifications.
171171
172-
### Review Instructions:
173-
Please review the changes to ensure:
174-
1. All double headers have been properly removed
175-
2. No content was accidentally deleted
176-
3. The documentation still reads naturally
177-
4. All MDX files remain valid
172+
### Review Instructions:
173+
Please review the changes to ensure:
174+
1. All double headers have been properly removed
175+
2. No content was accidentally deleted
176+
3. The documentation still reads naturally
177+
4. All MDX files remain valid
178178
179-
---
180-
*This PR was automatically generated by the documentation quality workflow.*"
179+
---
180+
*This PR was automatically generated by the documentation quality workflow.*"
181181
182182
# Create the PR using GitHub CLI
183183
gh pr create \

0 commit comments

Comments
Β (0)