Skip to content

Commit 2d3abba

Browse files
committed
docs: update style guide rules and add argument hints for skills
1 parent f7e492b commit 2d3abba

File tree

11 files changed

+8
-63
lines changed

11 files changed

+8
-63
lines changed

.claude/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ Before submitting:
9494
```bash
9595
npm run lint:md # Check markdown
9696
npm run lint:code # Check code
97+
vale "path/to/file.md" --minAlertLevel=error # Check prose style
9798
npm start # Preview changes
9899
npm test # Validate API specs
99100
```
@@ -103,7 +104,7 @@ npm test # Validate API specs
103104
1. **Read `AGENTS.md` first** - Vendor-agnostic documentation standards
104105
2. **Check `.claude/rules/`** - Auto-loaded standards for writing, formatting, terminology
105106
3. **Use the appropriate skill** - Designed for specific documentation tasks
106-
4. **Run linters before committing** - `npm run lint:md` and `npm run lint:code`
107+
4. **Run linters before committing** - `npm run lint:md`, `npm run lint:code`, and `vale`
107108
5. **Review before submit** - Use `/review-docs` skill for final checks
108109

109110
## Need help?

.claude/rules/content-standards.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff 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-
71
# Content Standards
82

93
Canonical formatting standards for all Apify documentation. These rules ensure consistency across platform docs, academy tutorials, and API references.

.claude/rules/file-organization.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
---
2-
description: File naming conventions and directory structure standards
3-
globs: ["sources/**/*"]
4-
alwaysApply: true
5-
---
6-
71
# File Organization Rules
82

93
## Naming conventions

.claude/rules/grammar-rules.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
---
2-
description: Grammar mechanics and punctuation rules for Apify documentation
3-
globs: ["sources/**/*.md", "sources/**/*.mdx"]
4-
alwaysApply: true
5-
---
6-
71
# Grammar rules
82

93
Grammar mechanics and punctuation rules for all Apify documentation. These complement the writing style and terminology guides.
@@ -171,6 +165,5 @@ Use the exact official spelling for tools and brand names:
171165
| Postgresql, Postgres | PostgreSQL |
172166
| Jquery | jQuery |
173167
| Wordpress | WordPress |
174-
| Elasticsearch | Elasticsearch |
175168
| VSCode, VS code | VS Code |
176169
| DockerFile, dockerfile | Dockerfile |

.claude/rules/quality-standards.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
---
2-
description: Content quality checklist and review standards
3-
globs: ["sources/**/*.md", "sources/**/*.mdx"]
4-
alwaysApply: true
5-
---
6-
71
# Quality Standards
82

93
Comprehensive quality checklist for all Apify documentation. Use this before submitting any content for review.

.claude/rules/terminology.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
---
2-
description: Official Apify product and technical terminology
3-
globs: ["sources/**/*.md", "sources/**/*.mdx", "apify-api/**/*.yaml"]
4-
alwaysApply: true
5-
---
6-
71
# Apify Terminology
82

93
Official capitalization and usage rules for Apify-specific terms. Use these exact forms throughout all documentation.

.claude/rules/writing-style.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
---
2-
description: Comprehensive writing style rules for Apify documentation
3-
globs: ["sources/**/*.md", "sources/**/*.mdx"]
4-
alwaysApply: true
5-
---
6-
71
# Apify Documentation Writing Style
82

93
Instructions for AI assistants writing Apify documentation. Based on Apify style guide and technical writer feedback.

.claude/skills/api-doc/SKILL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
name: api-doc
33
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.
4+
argument-hint: endpoint-path
45
---
56

67
# API documentation

.claude/skills/doc-write/SKILL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
name: doc-write
33
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.
4+
argument-hint: topic
45
---
56

67
# Documentation writer

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

Lines changed: 3 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
name: review-docs
33
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
45
---
56

67
# Documentation review
@@ -31,6 +32,7 @@ Review compliance against all standards in `.claude/rules/`:
3132
```bash
3233
npm run lint:md # Markdownlint - Markdown syntax/formatting
3334
npm run lint:code # ESLint - Code linting
35+
vale "path/to/file.md" --minAlertLevel=error # Vale - Prose and style
3436
```
3537

3638
## Review checklist
@@ -63,31 +65,6 @@ These aspects require judgment and aren't covered by the rules files:
6365
- [ ] **Accessibility** - Proper heading hierarchy, descriptive link text, image alt text
6466
- [ ] **SEO** - Descriptive title, meta description 140-160 chars, internal linking
6567

66-
## How to review
67-
68-
### Step 1: Run automated checks
69-
70-
```bash
71-
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-
9168
## Examples
9269

9370
Example 1: Pre-PR review
@@ -97,6 +74,7 @@ User says: "Review sources/platform/actors/running.md before I submit"
9774
Actions:
9875
1. Read the file
9976
1. Run `npx markdownlint "sources/platform/actors/running.md"`
77+
1. Run `vale "sources/platform/actors/running.md" --minAlertLevel=error`
10078
1. Check against review checklist
10179
1. Output structured review with strengths, issues, and priority fixes
10280

0 commit comments

Comments
 (0)