Skip to content

docs: fix incomplete configuration reference and missing doc files in agent skill #2981

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
afranken merged 2 commits into from
Feb 26, 2026
+15 −6
Merged

docs: fix incomplete configuration reference and missing doc files in agent skill #2981

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d7210e
Initial plan
Copilot Feb 26, 2026
6a314b3
docs: ensure concise documentation for customers, developers, skills …
Copilot Feb 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .claude/skills/document/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Read `AGENTS.md` (root + relevant module) before making changes.
| `CHANGELOG.md` | End users | Version history, breaking changes |
| `docs/TESTING.md` | Contributors / AI agents | Testing strategy, base classes, patterns, commands |
| `docs/KOTLIN.md` | Contributors / AI agents | Kotlin idioms, naming conventions, anti-patterns, KDoc |
| `docs/SPRING.md` | Contributors / AI agents | Spring Boot patterns, DI, controllers, exception handling |
| `docs/JAVA.md` | Contributors / AI agents | Java idioms, naming conventions, anti-patterns, Javadoc |
| `AGENTS.md` (root + modules) | AI agents | Architecture, conventions, guardrails |
| `.github/CONTRIBUTING.md` | Contributors | Dev setup, code reviews |

Expand All @@ -26,6 +28,10 @@ Read `AGENTS.md` (root + relevant module) before making changes.

**Architecture change**: relevant module's `AGENTS.md`, root `AGENTS.md` if cross-cutting, `CHANGELOG.md`.

**Spring Boot pattern change**: `docs/SPRING.md`, `server/AGENTS.md` if the change affects how controllers/services/stores are structured.

**Kotlin/Java style change**: `docs/KOTLIN.md` or `docs/JAVA.md`, root `AGENTS.md` DO/DON'T section if it introduces a new guardrail.

## CHANGELOG Format

Follow existing pattern: group under current version heading, clear user-facing language, note breaking changes, reference issues/PRs.
Expand Down
15 changes: 9 additions & 6 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,14 @@ Filesystem layout:

## Configuration

Environment variables (prefix: `COM_ADOBE_TESTING_S3MOCK_STORE_`):
- `ROOT` - storage directory
- `RETAIN_FILES_ON_EXIT` - keep files after shutdown
- `REGION` - AWS region (default: us-east-1)
- `INITIAL_BUCKETS` - comma-separated bucket names
- `VALID_KMS_KEYS` - valid KMS ARNs
Environment variables:
- `COM_ADOBE_TESTING_S3MOCK_STORE_ROOT` - storage directory
- `COM_ADOBE_TESTING_S3MOCK_STORE_RETAIN_FILES_ON_EXIT` - keep files after shutdown (default: false)
- `COM_ADOBE_TESTING_S3MOCK_STORE_REGION` - AWS region (default: us-east-1)
- `COM_ADOBE_TESTING_S3MOCK_STORE_INITIAL_BUCKETS` - comma-separated bucket names
- `COM_ADOBE_TESTING_S3MOCK_STORE_VALID_KMS_KEYS` - valid KMS ARNs
- `COM_ADOBE_TESTING_S3MOCK_CONTROLLER_CONTEXT_PATH` - base context path for all endpoints (default: "")
- `debug` / `trace` - Spring Boot log levels

## Error Handling

Expand All @@ -100,6 +102,7 @@ See **[docs/TESTING.md](docs/TESTING.md)** for the full testing strategy, base c
```bash
make install # Full build
make skip-docker # Skip Docker
make test # Unit tests only
make integration-tests # Run integration tests
make format # Format Kotlin code
```
Expand Down
Loading