Skip to content

Ensure the Style Checker spots em dashes #3002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pwizla merged 1 commit into from
Mar 11, 2026
Merged

Ensure the Style Checker spots em dashes #3002

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .cursor/rules/strapi-docs-style-checker.mdc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,14 @@ Beyond the 12 rules, also check for:
- **Severity:** warning
- **Note:** Strapi documentation always uses absolute-style paths starting with `/`. The `./` relative prefix should not appear in documentation prose or code examples referencing project file paths.

### Em dashes
- **Detect:** Em dashes (—) anywhere in prose
- **Severity:** error
- **Note:** Em dashes are not used in Strapi technical documentation. They are a common signal of AI-generated text. Replace with a colon, a period, or restructure the sentence.
- `"Status — shows the current state"` → `"Status: shows the current state"`
- `"The button — visible only to admins — opens the panel"` → `"The button opens the panel. It is only visible to admins."`
- **Exception:** Em dashes inside HTML comments (`<!-- ... -->`) and inside hyperlink text that references an external page title should NOT be flagged.

### Consistency
- **Detect:** Inconsistent terminology within the same document (e.g., "admin panel" vs "Admin Panel" vs "administration panel"); inconsistent heading capitalization
- **Severity:** warning
Expand Down
8 changes: 8 additions & 0 deletions agents/prompts/style-checker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,14 @@ Beyond the 12 rules, also check for:
- **Severity:** warning
- **Note:** Strapi documentation always uses absolute-style paths starting with `/`. The `./` relative prefix should not appear in documentation prose or code examples referencing project file paths.

### Em dashes
- **Detect:** Em dashes (—) anywhere in prose
- **Severity:** error
- **Note:** Em dashes are not used in Strapi technical documentation. They are a common signal of AI-generated text. Replace with a colon, a period, or restructure the sentence.
- `"Status — shows the current state"` → `"Status: shows the current state"`
- `"The button — visible only to admins — opens the panel"` → `"The button opens the panel. It is only visible to admins."`
- **Exception:** Em dashes inside HTML comments (`<!-- ... -->`) and inside hyperlink text that references an external page title should NOT be flagged.

### Consistency
- **Detect:** Inconsistent terminology within the same document (e.g., "admin panel" vs "Admin Panel" vs "administration panel"); inconsistent heading capitalization
- **Severity:** warning
Expand Down
Loading