Skip to content

Commit e367e61

Browse files
MarkvanMentsMarkvanMents
authored
Merge pull request mendix#11030 from mendix/MvM-RenameClaudeSkills
Update skill names and description
2 parents 520865b + 5097fff commit e367e61

13 files changed

Lines changed: 108 additions & 33 deletions

File tree

‎.claude/scripts/README.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Claude Helper Scripts
2+
3+
Utility scripts to support Claude Code when working with this documentation repository.
4+
5+
## resolve-doc-url.sh
6+
7+
Resolves a documentation URL to its source markdown file.
8+
9+
### Usage
10+
11+
```bash
12+
.claude/scripts/resolve-doc-url.sh "/path/to/page/"
13+
```
14+
15+
### Examples
16+
17+
```bash
18+
# Find the file for a specific URL
19+
.claude/scripts/resolve-doc-url.sh "/community-tools/contribute-to-mendix-docs/"
20+
# Output: content/en/docs/community-tools/contribute-to-mendix-docs/_index.md
21+
22+
# Check if a URL exists
23+
.claude/scripts/resolve-doc-url.sh "/some/page/"
24+
# Exit code 0 if found, 1 if not found
25+
```
26+
27+
### Benefits
28+
29+
- **Fast**: Uses grep optimized for file-only output
30+
- **Token-efficient**: Returns only the file path, no surrounding context
31+
- **Reliable**: Matches exact URL in front matter using fixed-string search
32+
33+
### When to Use
34+
35+
- Following cross-references between documentation pages
36+
- Validating internal links
37+
- Finding files by their published URL
38+
- Checking if a URL is already in use

‎.claude/scripts/resolve-doc-url.sh‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#!/bin/bash
2+
# Resolve a documentation URL to its source markdown file
3+
# Usage: resolve-doc-url.sh "/path/to/page/"
4+
5+
if [ -z "$1" ]; then
6+
echo "Usage: resolve-doc-url.sh <url>"
7+
echo "Example: resolve-doc-url.sh '/community-tools/contribute-to-mendix-docs/'"
8+
exit 1
9+
fi
10+
11+
# Search for the URL in front matter
12+
# Using grep with -l (files only) and -F (fixed string) for speed
13+
grep -rl --include="*.md" "^url: $1$" content/en/docs/
14+
15+
# Exit code 0 if found, 1 if not found

.claude/skills/add/SKILL.md renamed to .claude/skills/docs-add/SKILL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
name: add
3-
description: Adds new content to existing documentation pages while preserving the original structure and meaning. Integrates new sections, paragraphs, or information smoothly with appropriate transitions. Use when the user wants to add, insert, include, or append new content to existing pages without rewriting what's already there.
2+
name: docs-add
3+
description: Adds new content to a single documentation page while preserving the original structure and meaning. Integrates new sections, paragraphs, or information smoothly with appropriate transitions. Use when the user wants to add, insert, include, or append new content to existing pages without rewriting what's already there.
44
user-invocable: true
55
disable-model-invocation: true
66
---
77

8-
> **After adding content:** Consider running `/polish` to improve clarity or `/proofread` to check for errors in the final result.
8+
> **After adding content:** Consider running `/docs-polish` to improve clarity or `/docs-proofread` to check for errors in the final result.
99
1010
Ask the user for the new content to add. Determine a suitable place to smoothly integrate the new content into the existing content, with appropriate transitions and formatting, while preserving the original meaning and structure of the page. Don't make changes to existing content unless necessary for clarity or coherence when adding the new content.
1111

.claude/skills/enhance/SKILL.md renamed to .claude/skills/docs-enhance/SKILL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
name: enhance
3-
description: Performs comprehensive editing including reorganization, restructuring, and rephrasing while preserving original meaning and intent. Improves flow, strengthens weak phrasing, and enhances overall quality. Use when documentation needs significant structural improvements, better organization, or when the user mentions reorganize, restructure, rewrite, or enhance.
2+
name: docs-enhance
3+
description: Comprehensively edits a single documentation page including reorganization, restructuring, and rephrasing while preserving original meaning and intent. Improves flow, strengthens weak phrasing, and enhances overall quality. Use when documentation needs significant structural improvements, better organization, or when the user mentions reorganize, restructure, rewrite, or enhance.
44
user-invocable: true
55
disable-model-invocation: true
66
---
77

8-
> **Skill progression:** This is the most intensive editing. If restructuring isn't needed, use `/polish` for clarity improvements or `/proofread` for basic fixes.
8+
> **Skill progression:** This is the most intensive editing. If restructuring isn't needed, use `/docs-polish` for clarity improvements or `/docs-proofread` for basic fixes.
99
1010
Perform holistic improvements, including reorganization and stronger phrasing, while preserving original intent. This goes beyond basic proofreading and polishing to enhance the overall quality and impact of the text. Consider restructuring sentences, paragraphs, or sections for better flow, replacing weak words with stronger alternatives, and improving clarity and consistency while maintaining the original meaning. However, avoid making changes just for the sake of change; every edit should serve a clear purpose in enhancing the text.

.claude/skills/polish/SKILL.md renamed to .claude/skills/docs-polish/SKILL.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
name: polish
3-
description: Proofreads documentation and improves clarity, readability, and word choice without changing meaning or reorganizing structure. Simplifies complex sentences, applies style guide standards, and converts passive voice to active voice. Use when the user wants to polish, improve language and clarity, make more readable, check style guide compliance, or clean up documentation while preserving its structure.
2+
name: docs-polish
3+
description: Proofreads a single documentation page and improves clarity, readability, and word choice without changing meaning or reorganizing structure. Simplifies complex sentences, applies style guide standards, and converts passive voice to active voice. Use when the user wants to polish, improve language and clarity, make more readable, check style guide compliance, or clean up documentation while preserving its structure.
44
user-invocable: true
55
disable-model-invocation: false
66
---
77

8-
> **Skill progression:** This does everything `/proofread` does plus clarity improvements and style guide enforcement. If only grammar and spelling fixes are needed, use `/proofread`. For deeper reorganization, suggest `/enhance`.
8+
> **Skill progression:** This does everything `/docs-proofread` does plus clarity improvements and style guide enforcement. If only grammar and spelling fixes are needed, use `/docs-proofread`. For deeper reorganization, suggest `/docs-enhance`.
99
1010
Improve clarity and readability without changing meaning, structure, or paragraph order:
1111

12-
**Polish should**:
12+
**docs-polish should**:
1313
* Read Mendix style guides first (in parallel): `grammar-formatting.md`, `terminology.md`, and `product-naming-guide.md` from `/content/en/docs/community-tools/contribute-to-mendix-docs/style-guide/`
1414
* Fix all spelling, grammar, and punctuation errors
1515
* Add missing alt text to images (use simple, factual descriptions)
@@ -24,8 +24,8 @@ Improve clarity and readability without changing meaning, structure, or paragrap
2424
* Apply Mendix style guide standards (overrides the Microsoft Writing Style Guide)
2525
* Apply Microsoft Writing Style Guide standards, unless they conflict with the Mendix style guide standards
2626

27-
**Polish should NOT**:
28-
* Move paragraphs or restructure sections (that's `/enhance`)
27+
**docs-polish should NOT**:
28+
* Move paragraphs or restructure sections (that's `/docs-enhance`)
2929
* Change technical meaning or accuracy
3030
* Significantly increase document length
3131
* Change command syntax, code identifiers, variable names, placeholders, or any other text that appears in code formatting (inline backticks or code blocks). Code-formatted text represents literal technical content that must remain unchanged. If you notice an issue with code-formatted text, flag it in the chat but don't edit it directly.

‎.claude/skills/docs-pr-review/SKILL.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: docs-pr-review
3+
description: Analyzes all changes in a pull request and generates suggestions for improvements, clarifications, inconsistencies, and structural changes without making any edits. Use when the user asks to review, analyze, audit, or provide feedback on a pull request, or when they want suggestions before making changes.
4+
user-invocable: true
5+
disable-model-invocation: false
6+
---
7+
8+
Compare changes between the current branch and the base branch (typically `development`). Read the complete final state of each modified file, not just the diff, to ensure changes don't introduce inconsistencies with unchanged content.
9+
10+
Analyze all the changes in the current pull request or branch and return a list of suggestions or questions about any points to clarify, potential inconsistencies, and sections to restructure, add, or remove. Read the whole of each document modified in the pull request to ensure the changes do not make inconsistencies.
11+
12+
Follow links to other documents in the repo to check for inconsistencies if they seem to provide important related information.
13+
14+
Do not worry about possible invalid internal links to anchors in the repo as these will be picked up by a separate testing tool after the site has been built.
15+
16+
Make no edits.

.claude/skills/proofread/SKILL.md renamed to .claude/skills/docs-proofread/SKILL.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
name: proofread
3-
description: Checks and fixes spelling, grammar, punctuation, basic Markdown formatting, and required front matter fields. Makes minimal corrections without rewording or restructuring. Use when the user asks to proofread, check for spelling and grammar errors, or fix typos.
2+
name: docs-proofread
3+
description: Checks a single documentation page and fixes spelling, grammar, punctuation, basic Markdown formatting, and required front matter fields. Makes minimal corrections without rewording or restructuring. Use when the user asks to proofread, check for spelling and grammar errors, or fix typos.
44
user-invocable: true
55
disable-model-invocation: false
66
---
77

8-
> **Skill progression:** This is the lightest touch. If more clarity and style guide work is needed, suggest `/polish`. For deeper restructuring, suggest `/enhance`.
8+
> **Skill progression:** This is the lightest touch. If more clarity and style guide work is needed, suggest `/docs-polish`. For deeper restructuring, suggest `/docs-enhance`.
99
1010
Do NOT rewrite, rephrase, or improve clarity. Proofread only:
1111

@@ -29,4 +29,4 @@ Priority order for determining scope:
2929
3. If there are multiple open files, list them and ask which to process.
3030
4. If no files are open, ask for a file path.
3131

32-
If you notice style or clarity issues that need improvement, finish proofreading first, then suggest the user run `/polish` for those improvements.
32+
If you notice style or clarity issues that need improvement, finish proofreading first, then suggest that the user run `/docs-polish` for those improvements.

‎.claude/skills/docs-review/SKILL.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
name: docs-review
3+
description: Analyzes a single documentation page and generates suggestions for improvements, clarifications, inconsistencies, and structural changes without making any edits. Use when the user asks to review, analyze, audit, or provide feedback on a documentation page or section, or when they want suggestions before making changes.
4+
user-invocable: true
5+
disable-model-invocation: false
6+
---
7+
8+
Analyze the page and return a list of suggestions or questions about any points to clarify, potential inconsistencies, and sections to restructure, add, or remove. Make no edits.

‎.claude/skills/review/SKILL.md‎

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎CLAUDE.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,14 @@ Call tools in parallel for independent operations (reading multiple files, multi
110110
* **Glob** – Use to find files by pattern (e.g., `*.md`, `**/*config*`)
111111
* **Grep** – Use to search file contents for specific text or patterns
112112
* **Write** – Use only for creating new files (prefer Edit for existing files)
113+
* **Helper Scripts** – Use `.claude/scripts/resolve-doc-url.sh` to resolve documentation URLs (e.g., `/path/to/page/`) to their source markdown files. This is faster and more token-efficient than using Grep to search front matter.
113114

114115
### Cross-Reference Verification
115116

117+
When following or verifying documentation links:
118+
* Use `.claude/scripts/resolve-doc-url.sh "/path/to/page/"` to quickly find the source file for a URL
119+
* This is more efficient than Grep for URL-to-file lookups
120+
116121
When modifying URLs or anchor IDs:
117122
1. Use Grep to search for the old URL/anchor across all documentation files
118123
2. Identify all references that need updating

0 commit comments

Comments
 (0)