devvit-docs_skill

Overview

This skill looks up Devvit documentation from the reddit/devvit-docs repository to answer questions about Devvit APIs, patterns, configuration, and examples. It uses a local docs cache produced by a helper script and always cites the exact doc files and sections that support each answer.

How this skill works

Run the provided ensure-docs script to clone or refresh a local copy of the docs, then read the script's JSON output to determine the docs root to search. The skill searches that directory for relevant files, extracts supporting text and code snippets, and returns answers with explicit file/section citations. If the docs lack an answer, the skill states that and points to the closest related file.

When to use it

• You need an authoritative answer about a Devvit API, configuration option, or recommended pattern.
• You want a minimal example or code snippet that is present in the official Devvit docs.
• You need the exact file and section from the docs to cite in your code review or documentation.
• You want to verify behavior for a specific Devvit version listed in package.json.
• You need troubleshooting steps documented for Devvit tooling or the ensure-docs script.

Best practices

• Run node ./scripts/ensure-docs.cjs before asking to ensure the local cache is up to date.
• Provide the Devvit version or your package.json so the skill can choose a versioned docsRoot.
• Copy the quoted file path and section into your issue or PR to make verification easy.
• If network or git fails, use --force after resolving connectivity to refresh stale docs.
• Ask focused questions (API name, config key, or example) so the skill can return exact file citations.

Example use cases

• How do I register an API route in Devvit? (returns the exact doc file and snippet describing registration).
• Show me the example for creating a widget or module included in the docs.
• Which configuration keys control Devvit versioning and where are they documented?
• Troubleshoot ensure-docs errors like git not found or stale cache and get the documented remedies.
• Find the referenced Devvit version from package.json and locate the matching versioned docsRoot.