You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .claude/rules/content-standards.md
-6Lines changed: 0 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,3 @@
1
-
---
2
-
description: Standard formatting rules for all Apify documentation
3
-
globs: ["sources/**/*.md", "sources/**/*.mdx"]
4
-
alwaysApply: true
5
-
---
6
-
7
1
# Content Standards
8
2
9
3
Canonical formatting standards for all Apify documentation. These rules ensure consistency across platform docs, academy tutorials, and API references.
Copy file name to clipboardExpand all lines: .claude/skills/api-doc/SKILL.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,7 @@
1
1
---
2
2
name: api-doc
3
3
description: Create or update OpenAPI specifications and API documentation for Apify endpoints. Use when user says "add API endpoint", "create OpenAPI spec", "document this endpoint", "add code samples for API", "update API docs", or "api-doc". Handles OpenAPI YAML, schemas, code samples, and operation IDs.
Copy file name to clipboardExpand all lines: .claude/skills/doc-write/SKILL.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,7 @@
1
1
---
2
2
name: doc-write
3
3
description: Write or edit Apify documentation pages following the style guide. Use when user says "write docs for", "create a new page", "document this feature", "add documentation about", "edit this doc page", or "write a guide for [topic]". Handles platform docs, guides, and reference pages with proper formatting and structure.
Copy file name to clipboardExpand all lines: .claude/skills/review-docs/SKILL.md
+3-25Lines changed: 3 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,7 @@
1
1
---
2
2
name: review-docs
3
3
description: Review Apify documentation for style guide compliance, quality standards, and best practices. Use when user says "review this doc", "check this page", "audit documentation", "review before PR", "is this ready to publish", or "review-docs". Runs automated checks and manual review against Apify style guide.
4
+
argument-hint: file-path
4
5
---
5
6
6
7
# Documentation review
@@ -31,6 +32,7 @@ Review compliance against all standards in `.claude/rules/`:
31
32
```bash
32
33
npm run lint:md # Markdownlint - Markdown syntax/formatting
33
34
npm run lint:code # ESLint - Code linting
35
+
vale "path/to/file.md" --minAlertLevel=error # Vale - Prose and style
34
36
```
35
37
36
38
## Review checklist
@@ -63,31 +65,6 @@ These aspects require judgment and aren't covered by the rules files:
63
65
-[ ]**Accessibility** - Proper heading hierarchy, descriptive link text, image alt text
npm run lint:md # Markdownlint - Markdown syntax/formatting
72
-
npm run lint:code # ESLint - Code linting
73
-
```
74
-
75
-
### Step 2: Check style compliance
76
-
77
-
For each of the rules files listed above, review the content against that file's standards. Use a subagent per file to read the rules and check compliance. Collect all violations.
78
-
79
-
### Step 3: Content review
80
-
81
-
Go through the manual content review checklist above. These require human/AI judgment about structure, accuracy, and completeness.
82
-
83
-
### Step 4: Provide feedback
84
-
85
-
Format your review using the output template below.
86
-
87
-
```markdown
88
-
## Documentation review: [File name]
89
-
```
90
-
91
68
## Examples
92
69
93
70
Example 1: Pre-PR review
@@ -97,6 +74,7 @@ User says: "Review sources/platform/actors/running.md before I submit"
97
74
Actions:
98
75
1. Read the file
99
76
1. Run `npx markdownlint "sources/platform/actors/running.md"`
77
+
1. Run `vale "sources/platform/actors/running.md" --minAlertLevel=error`
100
78
1. Check against review checklist
101
79
1. Output structured review with strengths, issues, and priority fixes
0 commit comments