devvit-skills-setup_skill

Overview

This skill configures a repository to auto-apply Devvit skill guidance by ensuring agent instruction files include a Devvit docs rule and validating the devvit-docs skill. It looks for common instruction files like AGENTS.md or CLAUDE.md, inserts a standard rule block near the top if missing, and reports success or failure of any devvit-docs checks. It also creates AGENTS.md when no instruction file exists and summarizes all changes made.

How this skill works

The skill first checks whether the devvit-docs skill is present. If devvit-docs exists, it calls that skill with a test query (for example, "how does redis work") and surfaces any error returned. Next it scans the repo root for instruction files, inserts the required Devvit rule block near the top of the first found file (or creates AGENTS.md if none exist), and appends the test result to the change summary.

When to use it

• Preparing a repository to follow Devvit-specific documentation and code generation rules
• Ensuring automated agents always prefer Devvit documentation for Devvit-related APIs
• Adding a standard instruction block across multiple repos or projects
• Validating that devvit-docs is installed and working before relying on it in automations

Best practices

• Run the skill from the repository root so files are detected and edited in the correct location
• Ensure the repository is writable; handle permission errors before retrying
• Keep a backup or use version control so inserted changes can be reviewed or reverted
• If devvit-docs is missing, install it with: npx add-skill reddit/devvit-skills

Example use cases

• Onboarding a new project to use Devvit skills and ensure developers get consistent guidance
• Automating repository hygiene to include a rule that forces Devvit doc lookups for Devvit APIs
• Running a pre-commit or CI step that checks and enforces the presence of the Devvit rule block
• Troubleshooting why automated code generation is producing non-Devvit API suggestions