docs: Add Claude Code skills and instructions #2193
Conversation
Add comprehensive Claude Code configuration for the Apify documentation repository: - Main instructions.md with project overview, standards, and workflows - Four specialized skills: doc-write, api-doc, tutorial, and review-docs - Configuration file (claude.json) registering skills and context files - User guide (README.md) with quick start and usage examples - Setup summary documenting the complete infrastructure All skills based on existing AGENTS.md and CONTRIBUTING.md standards to ensure consistency across documentation. Includes templates, examples, quality checklists, and best practices for common documentation tasks. Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
Update all Claude Code instructions and skills to include important details
from personal instruction file:
Critical additions:
- Bold ONLY for UI elements, NEVER for emphasis (emphasized throughout)
- All admonitions MUST have titles (no exceptions)
- Apify-specific terminology section with exact capitalization rules
- Oxford comma requirement
- Simple present tense for headings (not gerunds)
- "Never make assumptions about product features"
- Front matter descriptions must explain value, not features
- Slug must match file path
- Simple English preference ("use" not "utilize")
- PR review process (check latest changes pulled first)
- Code review scope (comments and obvious mistakes only)
Updated files:
- instructions.md: Core standards with terminology and review process
- review-docs.md: Enhanced checklist with terminology verification
- doc-write.md: Added terminology section and updated checklist
- tutorial.md: Added terminology and formatting rules
- api-doc.md: Added terminology for API descriptions
Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
|
Preview for this PR was built for commit |
- Change H1 headings to H2 in all .claude files per Apify.H1 rule - Add blank lines around headings, lists, and code blocks in README.md - Add language specifications to code blocks in README.md - Update tutorial template to use H2 instead of H1 - Adjust Python comment formatting to avoid vale false positives Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
- Fix last vale error by consolidating Python comments in tutorial.md - Remove SETUP_SUMMARY.md as it duplicates README.md content Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
|
Preview for this PR was built for commit |
- Add blank lines around all headings, lists, and code blocks - Ensures MD022, MD032, and MD031 rules are satisfied Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
|
Preview for this PR was built for commit |
Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
- Change H2 back to H1 for first line (MD041 requirement) - Add blank lines around all headings, lists, and code blocks - These .claude files are infrastructure, not published docs Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
|
Preview for this PR was built for commit |
- Add .claude/**/*.md to vale.ini H1 exception (infrastructure docs like README) - Fix blank lines around headings, lists, and code blocks in all skill files - Add language specs to code blocks where possible - Add linting commands to instructions.md for local validation - 4 remaining MD040/MD001 errors are false positives from nested code examples Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
|
Preview for this PR was built for commit |
- Close markdown code block in review-docs.md properly - Reduces linting errors to 5 false positives from nested examples Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
|
Preview for this PR was built for commit |
- Add .claude to .markdownlintignore (infrastructure docs) - Configure vale to skip all checks for .claude/**/*.md files - These files are Claude Code configuration, not published documentation Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
marcel-rbro
force-pushed
the
docs/claude-code-infrastructure
branch
from
1a70c43 to
107b89c
Compare
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Won't this interfere with #2198 ? |
|
All content from this PR was moved to #2198 |
3 participants
Note
Establishes Claude Code infrastructure to streamline and standardize documentation work.
.claude/withinstructions.mddetailing project standards, workflows, and quality checksclaude.jsonand referencesAGENTS.mdandCONTRIBUTING.mdas contextskills/(doc-write.md,api-doc.md,tutorial.md,review-docs.md) with templates, conventions, and checklistsREADME.md) and a high-levelSETUP_SUMMARY.mddescribing structure and maintenanceWritten by Cursor Bugbot for commit 48af632. Configure here.