Skip to content

Commit 2d3fd79

Browse files
Phil Whittakerclaude
andcommitted
Fix remaining long sentences in best practice documentation
- Split line 116 in best-practice/README.md (27 words → 12 + 18 words) - Split line 9 in example-instructions.md (31 words → 13 + 18 words) - Updated Acronyms.yml All sentences now under 25 words for improved readability. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent dc78bfb commit 2d3fd79

File tree

3 files changed

+5
-2
lines changed

3 files changed

+5
-2
lines changed

.github/styles/UmbracoDocs/Acronyms.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ exceptions:
3030
- CMD # Command (Windows shell)
3131
- CMS # Content Management System
3232
- CPU # Central Processing Unit
33+
- CRM # Customer Relationship Management
34+
- CRUD # Create, Read, Update, Delete
3335
- CSS # Cascading Style Sheets
3436
- CTRL # Control (Keyboard key)
3537
- CURL # Client URL
@@ -112,6 +114,7 @@ exceptions:
112114
- UI # User Interface
113115
- URI # Uniform Resource Identifier
114116
- URL # Uniform Resource Locator
117+
- USB # Universal Serial Bus
115118
- UTC # Coordinated Universal Time
116119
- UUID # Universally Unique Identifier
117120
- UWP # Universal Windows Platform

16/umbraco-cms/reference/developer-mcp/best-practice/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,5 +113,5 @@ Offload rules, terminology, or structural constraints into a dedicated instructi
113113
Don’t try to do everything in one prompt. Sequence multi-step operations (e.g., create types → add content → apply relations) across multiple turns for better results.
114114

115115
{% hint style="info" %}
116-
If a prompt fails or produces a weak result, try these approaches: simplify it, restate it with clearer intent, or reduce the number of active tools.
116+
If a prompt fails or produces a weak result, try these approaches. Simplify it, restate it with clearer intent, or reduce the number of active tools.
117117
{% endhint %}

16/umbraco-cms/reference/developer-mcp/best-practice/example-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: Get the most out of the Umbraco CMS developer MCP server
66

77
Custom instructions help guide your AI assistant to follow your specific Umbraco development practices and conventions. By creating a `.claude/instructions.md` file in your project, you can ensure consistent behavior across all interactions with the MCP server.
88

9-
The example below demonstrates a comprehensive instruction file that covers tool usage, content structure, templates, and other best practices. The version of Umbraco (v16.2.0) is explicitly specified in the title, this helps AI assistants use version-specific documentation sources like Context7 to provide accurate guidance for your Umbraco installation.
9+
The example below demonstrates a comprehensive instruction file that covers tool usage, content structure, templates, and other best practices. The version of Umbraco (v16.2.0) is explicitly specified in the title. This helps AI assistants use version-specific documentation sources like Context7 to provide accurate guidance for your Umbraco installation.
1010

1111
Created by [Tom Madden](https://github.com/TwoMoreThings)
1212

0 commit comments

Comments
 (0)