Skip to content

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

Merged
afranken merged 2 commits intomainfrom
copilot/update-documentation-best-practices
Feb 26, 2026
Merged

docs: fix incomplete configuration reference and missing doc files in agent skill#2981
afranken merged 2 commits intomainfrom
copilot/update-documentation-best-practices

Conversation

Copy link
Contributor

Copilot AI commented Feb 26, 2026

AGENTS.md had an incomplete configuration section that omitted COM_ADOBE_TESTING_S3MOCK_CONTROLLER_CONTEXT_PATH (different prefix than the store variables) and the Spring Boot debug/trace flags. The document skill's file inventory was also missing docs/SPRING.md and docs/JAVA.md, leaving agents without guidance to update those files when Spring or Java patterns change.

Changes

AGENTS.md — Configuration

  • Replaced the misleading "prefix: COM_ADOBE_TESTING_S3MOCK_STORE_" shorthand with full variable names for all 7 variables
  • Added COM_ADOBE_TESTING_S3MOCK_CONTROLLER_CONTEXT_PATH (was entirely absent)
  • Added debug / trace Spring Boot log-level flags

AGENTS.md — Build

  • Added missing make test (unit tests only), consistent with Makefile and docs/TESTING.md

.claude/skills/document/SKILL.md

  • Added docs/SPRING.md and docs/JAVA.md to the Documentation Files table
  • Added "Spring Boot pattern change" and "Kotlin/Java style change" entries to the What to Update section

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…and agents

Co-authored-by: afranken <763000+afranken@users.noreply.github.com>
Copilot AI changed the title [WIP] Ensure concise documentation for customers and developers docs: fix incomplete configuration reference and missing doc files in agent skill Feb 26, 2026
@afranken afranken marked this pull request as ready for review February 26, 2026 13:22
@afranken afranken self-requested a review as a code owner February 26, 2026 13:22
Copilot AI review requested due to automatic review settings February 26, 2026 13:22
Copy link
Member

@afranken afranken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR fixes incomplete configuration documentation in AGENTS.md and updates the agent skill file to include missing documentation references. The changes ensure AI agents have accurate configuration details and proper guidance for updating Spring and Java documentation files.

Changes:

  • Expanded AGENTS.md configuration section with full environment variable names and added missing COM_ADOBE_TESTING_S3MOCK_CONTROLLER_CONTEXT_PATH and Spring Boot log-level flags
  • Added make test command to build section for consistency with Makefile and testing documentation
  • Updated .claude/skills/document/SKILL.md to include docs/SPRING.md and docs/JAVA.md in documentation inventory with corresponding update triggers

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
AGENTS.md Replaced shorthand configuration with full environment variable names, added missing CONTROLLER_CONTEXT_PATH and debug/trace flags, and added make test command
.claude/skills/document/SKILL.md Added docs/SPRING.md and docs/JAVA.md to documentation files table and included update triggers for Spring Boot and Kotlin/Java style changes

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@afranken afranken merged commit ef0dd8b into main Feb 26, 2026
11 checks passed
@afranken afranken deleted the copilot/update-documentation-best-practices branch February 26, 2026 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants