document

Generate and update S3Mock project documentation. Use when asked to document code, update CHANGELOG.md, update README.md, update AGENTS.md files, or fix formatting, wording, or style in any existing documentation file. Also invoked at the end of the implement skill workflow.

Jump to install Review files

Repository: adobe/S3Mock
Last source activity: July 27, 2026 at 17:34
Detected SKILL.md language: English
Stars: 1,180
Forks: 200

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Install with an AI assistant

Copy this prompt into the AI assistant you're using.

Follow https://skillsmp.com/skill-install/prompt.md to install only the Agent Skill at https://github.com/adobe/S3Mock/tree/main/.agents/skills/document.

A direct command skips the review prompt. Inspect the source before running it.

npx skills add https://github.com/adobe/S3Mock --skill document

The command stays on one line. Scroll horizontally to inspect it before copying.

Prefer a local copy? Download the files currently available to SkillsMP.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

SKILL.md

Source instructions · Read-only preview

name: document
description: Generate and update S3Mock project documentation. Use when asked to document code, update CHANGELOG.md, update README.md, update AGENTS.md files, or fix formatting, wording, or style in any existing documentation file. Also invoked at the end of the implement skill workflow.

# Documentation Skill ## Entry Criteria Use when asked to update `CHANGELOG.md`, `README.md`, `AGENTS.md` (root or module), or `docs/*.md`, or to fix formatting/wording in any documentation file. ## Execution Steps 1. Read root `AGENTS.md` and the relevant module `AGENTS.md`. 2. Determine which file(s) to update by scenario: | Scenario | Update | |---|---| | New S3 operation | `README.md` operations table, `CHANGELOG.md`, `server/AGENTS.md` if new patterns were introduced | | New API surface / port | `README.md` (enablement, ports, config, ops table, Docker examples), `CHANGELOG.md`, `server/AGENTS.md` | | Configuration change | `README.md` configuration table, root `AGENTS.md` Configuration section, `CHANGELOG.md` | | Architecture change | Relevant module `AGENTS.md`, root `AGENTS.md` if cross-cutting, `CHANGELOG.md` | | Spring Boot pattern change | `docs/SPRING.md`, `server/AGENTS.md` | | Kotlin/Java style change | `docs/KOTLIN.md` / `docs/JAVA.md`, root `AGENTS.md` DO/DON'T if a new guardrail is introduced | 3. For `CHANGELOG.md`: add under the current version heading (create it under `# CURRENT - 5.x - THIS VERSION IS UNDER ACTIVE DEVELOPMENT` if missing), matching the existing `Features and fixes` / `Refactorings` / `Version updates` bullet structure. Use clear, user-facing language; note breaking changes explicitly; reference GitHub issues/PRs where relevant. 4. Match surrounding style exactly (concise, active voice, runnable examples, links to [AWS S3 API docs](https://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html) where relevant). 5. Verify technical accuracy against source code, and that all links and code examples are valid and runnable. ## Completion Criteria - [ ] All files for the scenario updated (see table above) - [ ] Technical accuracy verified against source code - [ ] Links and code examples are valid - [ ] Matches surrounding style and formatting ## Resources - [`AGENTS.md`](../../../AGENTS.md) and relevant module `AGENTS.md` - [`CHANGELOG.md`](../../../CHANGELOG.md), [`README.md`](../../../README.md) — existing entries/tables to match

View on GitHub

Back to search Back to installation

implement

Implement features, fix bugs, and modify production source code in S3Mock. Use when asked to add functionality, change behavior, or modify source files in server/, integration-tests/, or testsupport/. Not for documentation-only or test-only changes. Orchestrates lint, test, and document skills as part of the complete workflow.

2026-07-27

lint

Fix code style issues and ensure linting CI gates pass in S3Mock. Use when ktlint or Checkstyle violations are reported, when asked to fix formatting, or as a required final step after any code change. Runs ktlint for Kotlin source files and Checkstyle for Java and XML files.

2026-07-27

refactor

Improve code readability, enforce idiomatic Kotlin conventions, and enhance documentation quality in S3Mock without changing behavior. Use when asked to clean up code, improve naming, add KDoc, or align with Kotlin/project idioms. Also invoked by the implement and test skills before adding new code to messy areas.

2026-07-27

View all from this repository

document

Source facts

Install options

Install with an AI assistant

Review the source files

More from this repository

Install with an AI assistant

More from this repository