Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
162 changes: 162 additions & 0 deletions .claude/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
# Claude Code configuration for Apify docs

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

## Structure

```text
.claude/
├── README.md # This file
├── instructions.md # Main instructions for Claude Code
└── 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 documentation following Apify style guide.

- Use for: New pages, content updates, reformatting
- Handles: Style compliance, formatting, structure

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

Work with OpenAPI specifications and API endpoints.

- Use for: New endpoints, schema updates, code samples
- Handles: OpenAPI structure, operation IDs, examples

#### `/tutorial` - Tutorial creation

Build structured, educational tutorials.

- Use for: New tutorials, tutorial restructuring
- Handles: Learning progression, examples, exercises

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

Review documentation for quality and compliance.

- Use for: Pre-submission checks, audits, consistency
- Handles: Style guide compliance, accessibility, SEO

## 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
```

## Primary references

Always reference these files from the repo root:

1. **`AGENTS.md`** - Core documentation standards (READ FIRST)
2. **`CONTRIBUTING.md`** - Setup, workflows, style guide
3. **`.cursor/rules/*.mdc`** - Cursor-specific rules (reference only)

## Key standards

### Writing style

- US English, active voice, inclusive language
- Sentence case for headings (not Title Case)
- Action-oriented phrasing
- No directional language (left/right)

### Front matter

Every file needs:

```yaml
---
title: "Action-oriented title"
description: "140-160 chars, no 'documentation' word"
sidebar_position: 1
slug: /path/to/page
---
```

### Formatting

- **Bold** for UI elements
- _Italics_ for emphasis
- `code` for inline code/files
- Code blocks with language tags
- Admonitions for important info

### Links & images

- Descriptive link text (not "click here")
- Alt text for all images
- Light theme for screenshots
- Red indicators for highlighting

## 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** - It's the source of truth
2. **Use the appropriate skill** - They're designed for specific tasks
3. **Test code examples** - All examples must work
4. **Check front matter** - Required for all files
5. **Run linters** - Before committing
6. **Review before submit** - Use `/review-docs`

## Maintenance

This configuration mirrors and extends the existing style guide:

- `AGENTS.md` - Vendor-agnostic standards
- `CONTRIBUTING.md` - Contribution process
- `.cursor/rules/*.mdc` - Cursor-specific rules

Keep these files in sync when updating documentation standards.

## 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"
]
}
Loading
Loading