Skip to content

chore(skills): improve review-docs, doc-write, and tutorial skills #2331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
TC-MO wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

chore(skills): improve review-docs, doc-write, and tutorial skills #2331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions .claude/skills/doc-write/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ All standards from `.claude/rules/` apply. Key doc-write checks:
- [ ] Each step has clear instructions
- [ ] Related documentation is linked
- [ ] No assumptions about product features (ask if unsure)
- [ ] Run `npm run lint:md` on the new or edited file
- [ ] Run `npm start` (or `npm run build`) to verify no broken links or slug conflicts

For the complete quality checklist, see `quality-standards.md`.

Expand Down
9 changes: 6 additions & 3 deletions .claude/skills/review-docs/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Review Apify documentation for style guide compliance, quality standards, and best practices. Use when user says "review this doc", "check this page", "audit documentation", "review before PR", "is this ready to publish", or "review-docs". Runs automated checks and manual review against Apify style guide.
argument-hint: file-path
allowed-tools: Read, Bash, Glob, Grep
allowed-tools: Read, Bash, Glob, Grep, Agent
---

# Documentation review
Expand All @@ -12,7 +12,10 @@ Review documentation for compliance with Apify style guide, quality standards, a

### Step 1: Check latest changes

**CRITICAL**: Verify you're reviewing the latest version of the file. If reviewing a PR, confirm the branch is up to date.
**CRITICAL**: Verify you're reviewing the latest version of the file before starting.

- If reviewing a local file: confirm no unsaved changes with `git status`
- If reviewing a PR: run `git fetch && git checkout <branch>` to ensure the branch is current

## Standards reference

Expand Down Expand Up @@ -73,7 +76,7 @@ User says: "Review sources/platform/actors/running.md before I submit"

Actions:
1. Read the file
1. Run `npx markdownlint "sources/platform/actors/running.md"`
1. Run `npm run lint:md` (or `npx markdownlint "sources/platform/actors/running.md"` for a single file)
1. Run `vale "sources/platform/actors/running.md" --minAlertLevel=error`
1. Check against review checklist
1. Output structured review with strengths, issues, and priority fixes
Expand Down
2 changes: 2 additions & 0 deletions .claude/skills/tutorial/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ All standards from `.claude/rules/` apply. Key tutorial-specific checks:
- [ ] Common issues addressed in troubleshooting
- [ ] Summary lists what user accomplished
- [ ] Next steps and related content linked
- [ ] Run `npm run lint:md` on the new file
- [ ] Run `npm start` (or `npm run build`) to verify no broken links or slug conflicts

For general quality standards (front matter, formatting, terminology), see `quality-standards.md`.

Expand Down
Loading