Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
17a933b
docs: Add Claude Code writing style guide
mnmkng Jan 21, 2026
eeba13d
Enhance writing style guide with accessibility and content type rules
mnmkng Jan 21, 2026
65ad77e
Fix linting errors in writing style guide
mnmkng Jan 21, 2026
9200730
Fix remaining table alignment issues
mnmkng Jan 21, 2026
91bc313
Move writing-style rules to .cursor/rules, symlink from .claude/rules
mnmkng Jan 21, 2026
0547c5e
Add symlinks for file-organization and quality-standards rules
mnmkng Jan 21, 2026
a8f4b38
Fix symlink direction: .claude/rules is now canonical source
mnmkng Jan 21, 2026
ab44144
Exclude AI assistant config files from Vale linting
mnmkng Jan 21, 2026
8f99fdd
Apply suggestions from code review
mnmkng Jan 26, 2026
20300a3
docs: add Claude Code infrastructure and skills
marcel-rbro Jan 21, 2026
6e65d16
docs: enhance Claude Code instructions with critical style rules
marcel-rbro Jan 21, 2026
1171a0b
fix: resolve vale and markdown lint errors
marcel-rbro Jan 21, 2026
08710d7
fix: resolve remaining vale error and remove redundant file
marcel-rbro Jan 21, 2026
34bfee2
fix: add blank lines for markdown lint compliance in instructions.md
marcel-rbro Jan 21, 2026
cde5c63
fix: add missing blank line after Admonition Format heading
marcel-rbro Jan 21, 2026
db0cf0b
fix: resolve markdown lint errors in skill files
marcel-rbro Jan 21, 2026
be52311
fix: resolve lint errors and add .claude files to vale H1 exception
marcel-rbro Jan 21, 2026
fc49082
fix: add closing fence to markdown code block example
marcel-rbro Jan 21, 2026
d1c4b8c
chore: ignore .claude directory in markdown and prose linting
marcel-rbro Jan 21, 2026
5b6dcd6
fix: remove outdated examples and improve clarity in documentation re…
marcel-rbro Jan 21, 2026
cc09b76
fix headings
marcel-rbro Jan 21, 2026
38ddbd6
fix heading casing
marcel-rbro Jan 21, 2026
cb3e6c7
fix headings_final
marcel-rbro Jan 21, 2026
9b130f9
fix: standardize heading casing and improve clarity in documentation
marcel-rbro Jan 21, 2026
4607e23
refactor: consolidate and reorganize .claude/ documentation
marcel-rbro Jan 26, 2026
b2719eb
feat: add comprehensive Claude Code documentation standards
marcel-rbro Jan 26, 2026
2c49bbf
fix: clarify heading hierarchy and admonition title requirements in q…
marcel-rbro Jan 28, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 112 additions & 0 deletions .claude/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
# Claude Code configuration for Apify docs

This directory contains Claude Code configuration for the Apify documentation repository.

## Structure

```text
.claude/
├── README.md # This file - Quick start guide
├── instructions.md # Main instructions for Claude Code
├── rules/ # Canonical standards (auto-loaded)
│ ├── writing-style.md # Language, tone, grammar
│ ├── content-standards.md # Formatting, front matter, code
│ ├── terminology.md # Apify-specific terms
│ ├── file-organization.md # Naming conventions
│ └── quality-standards.md # Quality checklist
└── skills/ # Reusable skills for common tasks
├── doc-write.md # Documentation writing skill
├── api-doc.md # API documentation skill
├── tutorial.md # Tutorial creation skill
└── review-docs.md # Documentation review skill
```

## How to use

### For Claude Code users

1. **Start a new session**: Claude Code will automatically read `instructions.md`
2. **Use skills**: Type `/doc-write`, `/api-doc`, `/tutorial`, or `/review-docs` to use specific skills
3. **Reference standards**: Always refer to `AGENTS.md` in the repo root for core standards

### Available skills

#### /doc-write
Documentation writing - Create or edit pages following style guide

#### /api-doc
API documentation - Work with OpenAPI specifications and endpoints

#### /tutorial
Tutorial creation - Build structured, educational tutorials

#### /review-docs
Documentation review - Check quality and compliance before submission

## Quick start

### Writing new documentation

```text
Use /doc-write skill to create a new documentation page about [topic]
```

### Creating a tutorial

```text
Use /tutorial skill to create a tutorial on [topic]
```

### Adding API endpoint

```text
Use /api-doc skill to document the new [endpoint-name] endpoint
```

### Reviewing documentation

```text
Use /review-docs skill to review sources/platform/[file-name].md
```

## Documentation standards

All documentation standards are in `.claude/rules/` (auto-loaded):

1. **`writing-style.md`** - Language, tone, grammar, headings, word choice
2. **`content-standards.md`** - Front matter, formatting, code examples, links, images
3. **`terminology.md`** - Apify-specific capitalization and product names
4. **`file-organization.md`** - File naming and directory structure
5. **`quality-standards.md`** - Comprehensive pre-submission checklist

Also reference:

- **`AGENTS.md`** - Vendor-agnostic documentation standards (in repo root)
- **`CONTRIBUTING.md`** - Setup, workflows, contribution process
- **`instructions.md`** - Full Claude Code instructions (in this directory)

## Testing

Before submitting:

```bash
npm run lint:md # Check markdown
npm run lint:code # Check code
npm start # Preview changes
npm test # Validate API specs
```

## Best practices

1. **Read `AGENTS.md` first** - Vendor-agnostic documentation standards
2. **Check `.claude/rules/`** - Auto-loaded standards for writing, formatting, terminology
3. **Use the appropriate skill** - Designed for specific documentation tasks
4. **Run linters before committing** - `npm run lint:md` and `npm run lint:code`
5. **Review before submit** - Use `/review-docs` skill for final checks

## Need help?

- Questions about style: Check `AGENTS.md`
- Setup issues: See `CONTRIBUTING.md`
- Skill usage: Read the specific skill file
- Claude Code general: Visit [Claude Code docs](https://github.com/anthropics/claude-code)
29 changes: 29 additions & 0 deletions .claude/claude.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"skills": [
{
"name": "doc-write",
"description": "Create or edit documentation following Apify style guide",
"path": "skills/doc-write.md"
},
{
"name": "api-doc",
"description": "Work with OpenAPI specifications and API documentation",
"path": "skills/api-doc.md"
},
{
"name": "tutorial",
"description": "Create structured tutorials with proper learning progression",
"path": "skills/tutorial.md"
},
{
"name": "review-docs",
"description": "Review documentation for style guide compliance and quality",
"path": "skills/review-docs.md"
}
],
"instructions": "instructions.md",
"context": [
"../AGENTS.md",
"../CONTRIBUTING.md"
]
}
231 changes: 231 additions & 0 deletions .claude/instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,231 @@
# Claude Code instructions for Apify documentation

## Project overview

You are working on the Apify documentation repository, which contains:

- **Platform documentation**: Core platform features and functionality (`/sources/platform/`)
- **Academy**: Educational content and tutorials (`/sources/academy/`)
- **API reference**: OpenAPI specifications (`/apify-api/`)

The project uses Docusaurus with MDX, follows Microsoft style guide principles, and has comprehensive style guidelines.

## Primary reference documents

**Always reference these files when working on documentation**:

1. **AGENTS.md** - Primary vendor-agnostic documentation standards (READ THIS FIRST)
2. **.claude/rules/** - Claude Code-specific standards (AUTO-LOADED)
- `writing-style.md` - Language, tone, grammar, and writing guidelines
- `content-standards.md` - Formatting, front matter, code examples, links, images
- `terminology.md` - Apify-specific capitalization and terminology
- `file-organization.md` - File naming and directory structure
- `quality-standards.md` - Comprehensive quality checklist
3. **CONTRIBUTING.md** - Contribution guidelines, setup, and workflows
4. `.cursor/rules/*.mdc` - Cursor-specific rules (for reference)

## Available skills

Use these skills for specific documentation tasks:

### `/doc-write` - Documentation writing

**When to use**: Creating or editing documentation pages
**Handles**: Content creation, formatting, style guide compliance

### `/api-doc` - API documentation

**When to use**: Working with OpenAPI specifications
**Handles**: Creating endpoints, schemas, code samples

### `/tutorial` - Tutorial creation

**When to use**: Creating step-by-step tutorials
**Handles**: Tutorial structure, learning content, examples

### `/review-docs` - Documentation review

**When to use**: Reviewing documentation before submission
**Handles**: Style guide compliance, quality checks, consistency

## Documentation standards

All documentation standards are defined in `.claude/rules/` and are auto-loaded by Claude Code:

- **Writing style**: See `writing-style.md` for language, tone, grammar, headings, and word choice
- **Content formatting**: See `content-standards.md` for front matter, text formatting, admonitions, code examples, links, and images
- **Terminology**: See `terminology.md` for Apify-specific capitalization and product names
- **File organization**: See `file-organization.md` for naming conventions and directory structure
- **Quality assurance**: See `quality-standards.md` for comprehensive pre-submission checklist

**Quick reference**:

- Use sentence case for headings (not Title Case)
- Bold only for UI elements (not emphasis)
- All admonitions must have titles
- Front matter required (title, description 140-160 chars, sidebar_position, slug)
- Use descriptive link text (never "click here")
- All code blocks must specify language

## File organization

### Naming conventions

- Use **kebab-case** for file names: `web-scraping-basics.md` (never camelCase or snake_case)
- Use descriptive names that reflect content
- Group related files in logical directories
- **Match slug to file path** for consistency

### Directory structure

```text
sources/
├── platform/ # Platform documentation
│ ├── actors/ # Actor-related content
│ ├── storage/ # Storage documentation
│ └── integrations/ # Integration guides
└── academy/ # Educational content
├── tutorials/ # Step-by-step guides
└── webscraping/ # Web scraping courses
```

## API documentation specifics

See the `/api-doc` skill for comprehensive OpenAPI specification standards, operation ID conventions, and path file naming.

## Development workflow

### Before starting work

1. Read `AGENTS.md` for documentation standards
2. Review `CONTRIBUTING.md` for specific guidelines
3. Check existing similar documentation for patterns
4. Determine which skill to use for the task

### During development

1. Follow the appropriate skill instructions
2. Reference `AGENTS.md` for style questions
3. Use proper front matter in all files
4. Include complete, tested code examples
5. Add descriptive links and alt text

### Before submitting

1. Run linting checks:

```bash
npm run lint:md # Markdownlint - Markdown syntax/formatting
npm run lint:code # ESLint - Code linting

# Run locally for more detailed output:
npx markdownlint "path/to/file.md" # Markdownlint - Check specific files
vale sync # Vale - Download styles (first time)
vale "path/to/file.md" --minAlertLevel=error # Vale - Check prose style
```

2. Use `/review-docs` skill to check compliance
3. Verify all code examples work
4. Check all links are valid
5. Ensure front matter is complete

### Testing changes

```bash
npm install # Install dependencies
npm start # Start development server
npm test # Validate OpenAPI specs (if applicable)
npm run build # Test production build
```

## Common patterns

See respective skills for content-type specific patterns:

- **Tutorials**: See `/tutorial` skill for 8-section tutorial structure
- **Platform documentation**: See `/doc-write` skill for feature documentation patterns
- **API documentation**: See `/api-doc` skill for endpoint documentation patterns

## Quality checklist

Before considering any documentation complete, see `quality-standards.md` for the comprehensive checklist and use the `/review-docs` skill for final review.

## Best practices

- Start with user's goal/problem
- Provide context before technical details
- Use consistent Apify terminology (see `terminology.md`)
- Structure content logically (basic → advanced)
- Link to related content
- Test all code examples before committing
- Never make assumptions about product features - ask if unsure
- For code review: check comments and obvious mistakes only

## Content review process

### Before reviewing a PR

- Check that the latest changes were pulled from the feature branch

### Review checklist

When reviewing or creating documentation, verify:

- **Clarity**: Instructions are easy to understand
- **Consistency**: Uniform terminology (see word list above) and style throughout
- **Grammar & Spelling**: Correct errors, use American English with Oxford commas
- **Structure**: Logical flow, no duplicate content, appropriate headings/lists
- **Links**: Verify all links are functional and relevant, link key terms to their docs
- **Code snippets**: Developer-provided; check comments and obvious mistakes only (not full code review)

## Getting help

If you're unsure about:

- **Style questions**: Check `AGENTS.md` first
- **Setup issues**: See `CONTRIBUTING.md`
- **API documentation**: See `/api-doc` skill
- **Tutorial structure**: See `/tutorial` skill
- **Review process**: See `/review-docs` skill
- **Product features**: Never make assumptions - ask if unsure

## Project-specific context

### Multiple repositories

The full documentation ecosystem includes multiple repos:

- apify-docs (this repo) - Platform, Academy, OpenAPI
- apify-client-js - JavaScript client docs
- apify-client-python - Python client docs
- apify-sdk-js - JavaScript SDK docs
- apify-sdk-python - Python SDK docs
- apify-cli - CLI documentation

### Theme

Uses `@apify/docs-theme` package - don't modify theme files directly.

### Deployment

- Automatic deployment on merge to `master`
- Preview builds available for pull requests
- Uses nginx for routing between repositories

### Linting tools

- **markdownlint** - Markdown syntax and formatting validation
- **eslint** - JavaScript/TypeScript code linting
- **Vale** - Prose style checking (optional, download styles with `vale sync`)

## Remember

The goal is to help users succeed with Apify. Every piece of documentation should:

- Be **clear** and easy to understand
- Be **accurate** and technically correct
- Be **actionable** with concrete examples
- Follow the **style guide** consistently
- Provide **real value** to users

When in doubt, prioritize clarity and usefulness over strict adherence to rules. But always maintain consistency within the documentation set.
Loading
Loading