Skip to content

Commit be006b3

Browse files
marcel-rbromarcel-rbro
authored
Merge branch 'master' into docs/ppe-plus-creator-facing
2 parents f4c2fd3 + 931fb52 commit be006b3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+1139
-192
lines changed

‎.claude/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ This directory contains Claude Code configuration for the Apify documentation re
1515
│ ├── file-organization.md # Naming conventions
1616
│ └── quality-standards.md # Quality checklist
1717
└── skills/ # Reusable skills for common tasks
18-
├── doc-write.md # Documentation writing skill
19-
├── api-doc.md # API documentation skill
20-
├── tutorial.md # Tutorial creation skill
21-
└── review-docs.md # Documentation review skill
18+
├── doc-write/ # Documentation writing skill
19+
├── api-doc/ # API documentation skill
20+
├── tutorial/ # Tutorial creation skill
21+
└── review-docs/ # Documentation review skill
2222
```
2323

2424
## How to use

‎.claude/claude.json‎

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,4 @@
11
{
2-
"skills": [
3-
{
4-
"name": "doc-write",
5-
"description": "Create or edit documentation following Apify style guide",
6-
"path": "skills/doc-write.md"
7-
},
8-
{
9-
"name": "api-doc",
10-
"description": "Work with OpenAPI specifications and API documentation",
11-
"path": "skills/api-doc.md"
12-
},
13-
{
14-
"name": "tutorial",
15-
"description": "Create structured tutorials with proper learning progression",
16-
"path": "skills/tutorial.md"
17-
},
18-
{
19-
"name": "review-docs",
20-
"description": "Review documentation for style guide compliance and quality",
21-
"path": "skills/review-docs.md"
22-
}
23-
],
242
"instructions": "instructions.md",
253
"context": [
264
"../AGENTS.md",

‎.claude/rules/content-standards.md‎

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,28 @@ slug: /academy/tutorials/web-scraper
6262

6363
**Sentence case only.** Capitalize only the first word and proper nouns.
6464

65-
| Avoid | Prefer |
66-
|-------|--------|
67-
| Store And Manage Data | Store and manage data |
68-
| Getting Started With Actors | Get started with Actors |
65+
#### Common mistakes
66+
67+
| Avoid (Title Case) | Prefer (Sentence case) | Rule |
68+
|-------------------|------------------------|------|
69+
| Store And Manage Data | Store and manage data | Lowercase articles, conjunctions, prepositions |
70+
| Getting Started With Actors | Get started with Actors | "Actors" stays capitalized (Apify product name) |
71+
| Use The Apify SDK | Use the Apify SDK | "SDK" stays capitalized (acronym) |
72+
| Advanced Web Scraping Techniques | Advanced web scraping techniques | Lowercase generic terms |
73+
| Configure GitHub Actions | Configure GitHub Actions | Preserve proper noun capitalization |
74+
| Connect To Google Sheets | Connect to Google Sheets | Lowercase prepositions ("to") |
75+
| Set Up Your Environment | Set up your environment | Lowercase articles ("your") |
76+
| API Reference Documentation | API reference documentation | Keep acronyms capitalized, rest lowercase |
77+
| Working With Docker Containers | Work with Docker containers | "Docker" stays capitalized (product name) |
78+
| Extend The Base Image | Extend the base image | Lowercase "the" mid-sentence |
79+
| How Do I Start? | How do I start? | Capitalize "I" in questions |
80+
| Understanding Request Queues | Understand request queues | Lowercase feature names |
81+
| Enable Standby Mode | Enable standby mode | Lowercase mode names |
82+
| Access The Apify Console | Access the Apify Console | "Apify Console" stays capitalized (product) |
83+
| Run Your First Actor | Run your first Actor | "Actor" capitalized, "your" lowercase |
84+
| Manage Node Modules | Manage node modules | Lowercase generic terms |
85+
| Step 1: install the dependencies | Step 1: Install the dependencies | Capitalize after colon (starts new clause) |
86+
| Option 2: use the alternative approach | Option 2: Use the alternative approach | Capitalize after colon (starts new clause) |
6987

7088
### Form
7189

‎.claude/rules/quality-standards.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,30 @@ alwaysApply: true
88

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

11+
## Automated changes verification
12+
13+
:::danger Critical requirement for AI assistants
14+
15+
**When using regex, find-and-replace, or any automated command to perform mass changes across files, you MUST verify every single change individually before committing.**
16+
17+
Automated replacements are error-prone and can break:
18+
- **Headings:** Proper nouns (GitHub, Docker), Apify products (Actors, Console), acronyms (API, SDK), capitalization after colons
19+
- **Code examples:** Variable names, API endpoints, function calls, configuration values
20+
- **Links:** URL paths, anchor references, file paths
21+
- **Terminology:** Product names, feature names, technical terms with specific capitalization
22+
- **Context-specific formatting:** Bold UI elements vs regular text, inline code vs prose
23+
24+
**Required process:**
25+
1. Run the automated replacement command
26+
1. Review the complete `git diff` output
27+
1. Check every single changed line individually
28+
1. Manually correct any broken proper nouns, acronyms, or context-dependent cases
29+
1. Only commit after verifying all changes line-by-line
30+
31+
Never commit automated changes without verifying each one. Use diff tools to catch errors before committing.
32+
33+
:::
34+
1135
## Complete quality checklist
1236

1337
Before submitting documentation, verify:

‎.claude/rules/writing-style.md‎

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,24 @@ Use active voice. Avoid gendered terms. Don't use directional language ("left/ri
7676

7777
**Sentence case only.** No title case.
7878

79-
| Avoid | Prefer |
80-
| --------------------- | --------------------- |
79+
Common mistakes: Capitalizing articles (the, a, an), prepositions (to, with, from), and conjunctions (and, or, but).
80+
81+
| Avoid (Title Case) | Prefer (Sentence case) |
82+
| ------------------ | ---------------------- |
8183
| Store And Manage Data | Store and manage data |
84+
| Use The Apify SDK | Use the Apify SDK |
85+
| Connect To Google Sheets | Connect to Google Sheets |
86+
| Configure GitHub Actions | Configure GitHub Actions |
87+
| How Do I Start? | How do I start? |
88+
89+
**Preserve proper nouns and acronyms:** Apify products (Actors, Console, Proxy), external tools (GitHub, Docker, Playwright), and acronyms (API, SDK, CLI) stay capitalized.
90+
91+
**Capitalize after colons:** When a colon introduces a complete clause or instruction, capitalize the first word after it.
92+
93+
| Avoid | Prefer |
94+
| ----- | ------ |
95+
| Step 1: install the dependencies | Step 1: Install the dependencies |
96+
| Option 2: use the alternative | Option 2: Use the alternative |
8297

8398
**No gerunds (-ing forms).** Use noun phrases or imperatives.
8499

@@ -87,6 +102,11 @@ Use active voice. Avoid gendered terms. Don't use directional language ("left/ri
87102
| Finding available tags | Available tags |
88103
| Getting started with Actors | Get started with Actors |
89104
| Understanding the API | API overview |
105+
| Setting up your environment | Set up your environment |
106+
| Using Docker containers | Use Docker containers |
107+
| Building your first Actor | Build your first Actor |
108+
| Running the scraper | Run the scraper |
109+
| Extending the base image | Extend the base image |
90110

91111
Rationale: Noun-phrase headings are more scannable and search-friendly (Microsoft style guide).
92112

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

File renamed without changes.

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

File renamed without changes.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,8 @@ Use this streamlined checklist for reviews. For detailed standards, see `.claude
107107
- Keywords used naturally
108108

109109
- [ ] **Content-type specific checks**
110-
- **Tutorials** (see `tutorial.md` skill): Clear learning objectives, prerequisites listed, sequential numbered steps, summary and next steps
111-
- **API docs** (see `api-doc.md` skill): Operation IDs follow conventions, all parameters documented, code samples included (JS, Python, cURL), error responses documented
110+
- **Tutorials** (see `/tutorial` skill): Clear learning objectives, prerequisites listed, sequential numbered steps, summary and next steps
111+
- **API docs** (see `/api-doc` skill): Operation IDs follow conventions, all parameters documented, code samples included (JS, Python, cURL), error responses documented
112112
- **Reference pages**: Comprehensive parameter tables, default values specified, type information included
113113

114114
## How to review

.claude/skills/tutorial.md renamed to .claude/skills/tutorial/SKILL.md

File renamed without changes.

‎.github/workflows/actions-checks.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ jobs:
1414
- name: Checkout repository
1515
uses: actions/checkout@v6
1616
- name: Run actionlint
17-
uses: rhysd/actionlint@v1.7.10
17+
uses: rhysd/actionlint@v1.7.11

0 commit comments

Comments
 (0)