Skip to content

Commit 255f5fb

Browse files
authored
Merge branch 'master' into docs/data-retention
2 parents 6c7bf0e + 4c56090 commit 255f5fb

File tree

860 files changed

+33916
-27590
lines changed

Some content is hidden

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

860 files changed

+33916
-27590
lines changed

.claude/README.md

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# Claude Code configuration for Apify docs
2+
3+
This directory contains Claude Code configuration for the Apify documentation repository.
4+
5+
## Structure
6+
7+
```text
8+
.claude/
9+
├── README.md # This file - Quick start guide
10+
├── instructions.md # Main instructions for Claude Code
11+
├── rules/ # Canonical standards (auto-loaded)
12+
│ ├── writing-style.md # Prose voice and tone
13+
│ ├── content-standards.md # Formatting and structure
14+
│ ├── terminology.md # Product names and capitalization
15+
│ ├── file-organization.md # Naming conventions
16+
│ ├── grammar-rules.md # Grammar mechanics, punctuation, numbers, brand spelling
17+
│ └── quality-standards.md # Quality checklist
18+
└── skills/ # Reusable skills for common tasks
19+
├── doc-write/ # Documentation writing skill
20+
├── api-doc/ # API documentation skill
21+
├── tutorial/ # Tutorial creation skill
22+
└── review-docs/ # Documentation review skill
23+
```
24+
25+
## How to use
26+
27+
### For Claude Code users
28+
29+
1. **Start a new session**: Claude Code will automatically read `instructions.md`
30+
2. **Use skills**: Type `/doc-write`, `/api-doc`, `/tutorial`, or `/review-docs` to use specific skills
31+
3. **Reference standards**: Always refer to `AGENTS.md` in the repo root for core standards
32+
33+
### Available skills
34+
35+
#### /doc-write
36+
Documentation writing - Create or edit pages following style guide
37+
38+
#### /api-doc
39+
API documentation - Work with OpenAPI specifications and endpoints
40+
41+
#### /tutorial
42+
Tutorial creation - Build structured, educational tutorials
43+
44+
#### /review-docs
45+
Documentation review - Check quality and compliance before submission
46+
47+
## Quick start
48+
49+
### Writing new documentation
50+
51+
```text
52+
Use /doc-write skill to create a new documentation page about [topic]
53+
```
54+
55+
### Creating a tutorial
56+
57+
```text
58+
Use /tutorial skill to create a tutorial on [topic]
59+
```
60+
61+
### Adding API endpoint
62+
63+
```text
64+
Use /api-doc skill to document the new [endpoint-name] endpoint
65+
```
66+
67+
### Reviewing documentation
68+
69+
```text
70+
Use /review-docs skill to review sources/platform/[file-name].md
71+
```
72+
73+
## Documentation standards
74+
75+
All documentation standards are in `.claude/rules/` (auto-loaded):
76+
77+
1. **`writing-style.md`** - Prose voice and tone
78+
1. **`content-standards.md`** - Formatting and structure
79+
1. **`terminology.md`** - Product names and capitalization
80+
1. **`grammar-rules.md`** - Grammar mechanics, punctuation, numbers, brand spelling
81+
1. **`file-organization.md`** - File naming and directory structure
82+
1. **`quality-standards.md`** - Complete quality checklist
83+
84+
Also reference:
85+
86+
- **`AGENTS.md`** - Vendor-agnostic documentation standards (in repo root)
87+
- **`CONTRIBUTING.md`** - Setup, workflows, contribution process
88+
- **`instructions.md`** - Full Claude Code instructions (in this directory)
89+
90+
## Testing
91+
92+
Before submitting:
93+
94+
```bash
95+
npm run lint:md # Check markdown
96+
npm run lint:code # Check code
97+
vale "path/to/file.md" --minAlertLevel=error # Check prose style
98+
npm run openapi:lint # Validate OpenAPI specs
99+
npm start # Preview changes
100+
```
101+
102+
## Best practices
103+
104+
1. **Read `CLAUDE.md` first**
105+
2. **Check `.claude/rules/`** - Auto-loaded standards for writing, formatting, terminology
106+
3. **Use the appropriate skill** - Designed for specific documentation tasks
107+
4. **Run linters before committing** - `npm run lint:md`, `npm run lint:code`, and `vale`
108+
5. **Review before submit** - Use `/review-docs` skill for final checks
109+
110+
## Need help?
111+
112+
- Questions about style: Check `AGENTS.md`
113+
- Setup issues: See `CONTRIBUTING.md`
114+
- Skill usage: Read the specific skill file
115+
- Claude Code general: Visit [Claude Code docs](https://github.com/anthropics/claude-code)

.claude/claude.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"instructions": "instructions.md",
3+
"context": [
4+
"../CONTRIBUTING.md"
5+
]
6+
}

.claude/instructions.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Claude Code instructions for Apify documentation
2+
3+
`CLAUDE.md` (symlink to `AGENTS.md`) covers project architecture, commands, and common pitfalls. Documentation standards are auto-loaded from `.claude/rules/` - those are the canonical source for all writing, formatting, and terminology rules.
4+
5+
## Available skills
6+
7+
| Skill | When to use |
8+
|---|---|
9+
| `/doc-write` | Creating or editing documentation pages |
10+
| `/api-doc` | Working with OpenAPI specifications |
11+
| `/tutorial` | Creating step-by-step tutorials |
12+
| `/review-docs` | Reviewing documentation before submission |
13+
14+
## PR title format
15+
16+
Use [Conventional Commits](https://www.conventionalcommits.org/) - enforced by CI:
17+
18+
- `docs: <description>` - Documentation changes (most common)
19+
- `fix: <description>` - Bug fixes
20+
- `feat: <description>` - New features
21+
- `chore: <description>` - Maintenance tasks
22+
23+
## Key reminders
24+
25+
- Never make assumptions about product features - ask if unsure
26+
- For code review: check comments and obvious mistakes only (not full code review)
27+
- Prioritize clarity and usefulness over strict rule adherence
28+
- See `CONTRIBUTING.md` for development setup and contribution workflow

0 commit comments

Comments
 (0)