Skip to content

Commit 22b2b1f

Browse files
committed
Mirror PR #3169 changes to inki/references/ for agents/ files migrated by Inki
1 parent 5e918b9 commit 22b2b1f

2 files changed

Lines changed: 9 additions & 4 deletions

File tree

claude-plugins/inki/references/authoring/AGENTS.cms.features.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,10 @@ Heading Conventions
5454
- Use H2 for major sections (Configuration, Usage); H3 for subsections.
5555
- Keep headings action‑oriented and specific (e.g., “Admin panel configuration”, not “Configuration details”).
5656

57+
Sidebar
58+
- Feature pages use flat `type: 'doc'` entries in `sidebars.js`. Never create, replace, or convert them to `type: 'category'` entries.
59+
- If a feature has sub-pages (e.g., API references), link to them from the page content using `<CustomDocCardsWrapper>` and `<CustomDocCard>` components — not via sidebar nesting.
60+
5761
Cross‑linking
5862
- Link to related features (e.g., Content‑type Builder, Content Manager) and relevant API references.
5963
- Prefer relative links within `/cms/` and use the consistent link text used across docs.

claude-plugins/inki/references/prompts/style-checker.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -191,13 +191,14 @@ Beyond the 12 rules, also check for:
191191
- **Severity:** warning
192192
- **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.
193193

194-
### Em dashes
195-
- **Detect:** Em dashes (—) anywhere in prose
194+
### Em dashes and double hyphens
195+
- **Detect:** Em dashes (—) and double hyphens used as dashes ( -- ) anywhere in prose
196196
- **Severity:** error
197-
- **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.
197+
- **Note:** Neither em dashes nor double hyphens are used as dashes in Strapi technical documentation. They are a common signal of AI-generated text. Replace with a colon, a period, parentheses, or restructure the sentence.
198198
- `"Status — shows the current state"``"Status: shows the current state"`
199199
- `"The button — visible only to admins — opens the panel"``"The button opens the panel. It is only visible to admins."`
200-
- **Exception:** Em dashes inside HTML comments (`<!-- ... -->`) and inside hyperlink text that references an external page title should NOT be flagged.
200+
- `"the token -- received by email"``"the token (received by email)"`
201+
- **Exception:** Em dashes and double hyphens inside HTML comments (`<!-- ... -->`), code fences, and inside hyperlink text that references an external page title should NOT be flagged.
201202

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

0 commit comments

Comments
 (0)