OpenParable
Skip to content
← Back to skills

Reviewdocs

Documents
reviewdocs

Reviewdocs is an Agent Skill for documents published in the hashicorp/terraform-provider-aws repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Review a PR's end user documentation updates.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/hashicorp/terraform-provider-aws/blob/HEAD/.agents/skills/reviewdocs/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/reviewdocs, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Skill: Review End User Documentation

Assume the @maintainer persona.

Determine whether a GitHub Pull Request should include documentation updates. If so, review the documentation updates for accuracy, completeness, and adherence to style guidelines. Provide feedback on necessary changes. If the PR should include documentation updates but does not, provide feedback on what documentation should be added. If the PR should not include documentation updates but does, provide feedback on what documentation should be removed.

Review only the documentation changes included in the PR. Do not review other code changes, except to the extent necessary to understand the documentation changes. Do not review any unchanged documentation.

Authoritative reference: docs/end-user-documentation.md. When this skill and that document disagree, the document wins.

Do not review any CHANGELOG updates.

When to use

Trigger this skill when the user:

  • Provides a https://github.com/hashicorp/terraform-provider-aws/pull/<N> URL and asks for a documentation review.
  • Says "review documentation", or similar, with a PR URL.

Inputs

Required:

  • A GitHub PR URL. Extract <PR_NUMBER> with the regex /pull/(\d+).

If the user provides only a PR number, ask for the full URL (or confirm the repo is hashicorp/terraform-provider-aws).