Skip to content
doc-check logo

Documentation Check Skill

doc-check

Checks if code changes require documentation updates

SKILL.md

Full skill instructions

Documentation Check Skill

Review code changes and determine if documentation updates or new documentation is needed.

Workflow

  1. Get the code changes - Use the method provided in the prompt, or if none specified:

    • For a PR: gh pr diff <PR_NUMBER> --repo coder/​coder
    • For local changes: git diff main or git diff --staged
    • For a branch: git diff main...<branch>
  2. Understand the scope - Consider what changed:

    • Is this user-facing or internal?
    • Does it change behavior, APIs, CLI flags, or configuration?
    • Even for "internal" or "chore" changes, always verify the actual diff
  3. Search the docs for related content in docs/

  4. Decide what's needed:

    • Do existing docs need updates to match the code?
    • Is new documentation needed for undocumented features?
    • Or is everything already covered?
  5. Report findings - Use the method provided in the prompt, or if none specified, summarize findings directly

What to Check

  • Accuracy: Does documentation match current code behavior?
  • Completeness: Are new features/​options documented?
  • Examples: Do code examples still work?
  • CLI/​API changes: Are new flags, endpoints, or options documented?
  • Configuration: Are new environment variables or settings documented?
  • Breaking changes: Are migration steps documented if needed?
  • Premium features: Should docs indicate (Premium) in the title?

Key Documentation Info

  • docs/​manifest.json - Navigation structure; new pages MUST be added here
  • docs/​reference/​cli/​*.md - Auto-generated from Go code, don't edit directly
  • Premium features - H1 title should include (Premium) suffix

Coder-Specific Patterns

Callouts

Use GitHub-Flavored Markdown alerts:

> [!NOTE]
> Additional helpful information.

> [!WARNING]
> Important warning about potential issues.

> [!TIP]
> Helpful tip for users.

CLI Documentation

CLI docs in docs/​reference/​cli/ are auto-generated. Don't suggest editing them directly. Instead, changes should be made in the Go code that defines the CLI commands (typically in cli/ directory).

Code Examples

Use sh for shell commands:

coder server --flag-name value

More Productivity & Planning skills

brainstorming logo
Productivity & Planning

brainstorming

Structured design dialogue that validates ideas before implementation begins.

295.4K 385.7K
View
ui-ux-pro-max logo
Productivity & Planning

ui-ux-pro-max

Comprehensive design intelligence for web and mobile UI/UX across 10 technology stacks.

133.1K 383.9K
View
writing-plans logo
Productivity & Planning

writing-plans

Comprehensive implementation plans for multi-step tasks, breaking down specs into bite-sized, testable steps.

295.4K 268K
View
using-superpowers logo
Productivity & Planning

using-superpowers

Introduction to the obra skills system with mandatory skill invocation rules and best practices.

295.4K 259.8K
View
executing-plans logo
Productivity & Planning

executing-plans

Execute a written implementation plan with critical review and task checkpoints.

295.4K 229.1K
View
dispatching-parallel-agents logo
Productivity & Planning

dispatching-parallel-agents

Delegate independent tasks to specialized agents working concurrently with isolated context.

295.4K 206.3K
View
using-git-worktrees logo
Productivity & Planning

using-git-worktrees

Isolated git worktrees with smart directory selection and safety verification.

295.4K 205.2K
View
webapp-testing logo
Productivity & Planning

webapp-testing

Toolkit for interacting with and testing local web applications using Playwright. Supports verifying frontend functionality, debugging UI behavior, capturing browser screenshots, and viewing browser logs.

179.7K 170.6K
View
content-strategy logo
Productivity & Planning

content-strategy

Plan searchable and shareable content that drives traffic, builds authority, and generates leads.

53.3K 150.9K
View
repo-intake-and-plan logo
Productivity & Planning

repo-intake-and-plan

README-first repository scanner that extracts commands and classifies reproduction candidates without executing them.

497 139.6K
View
marketing-ideas logo
Productivity & Planning

marketing-ideas

Brainstorm and prioritize marketing strategies tailored to your SaaS stage, budget, and goals.

53.3K 137.2K
View
site-architecture logo
Productivity & Planning

site-architecture

Plan and optimize your website's page hierarchy, navigation, URL structure, and internal linking.

53.3K 112.8K
View

Productivity AI tools

Vimcal logo
Productivity

Vimcal

The world's fastest calendar for remote work

Free
View
SaveDay logo
Productivity

SaveDay

Capture, organize, and utilize your knowledge effortlessly.

Free
View
Any Summary logo
Productivity

Any Summary

Instant Summaries of Audio & Video Interviews with AnySummary

Freemium
View
M
Productivity

Map This

Transform PDFs into engaging mind maps.

Freemium
View
ChatPDF logo
Productivity

ChatPDF

Chat with any PDF instantly

Free
View
I
Productivity

intellisay

Create an optimal daily plan using your voice

Paid
View
A
Productivity

Aurora AI

A productivity platform to centralize organizational knowledge and workflows with contextual AI assistance.

Paid
View
AskYourPDF logo
Productivity

AskYourPDF

AskYourPDF Pricing Plans: Tailored to Your Needs

Free
View