◐ Shell
clean mode source ↗

improve: add documentation guidline for agents by csviri · Pull Request #3339 · operator-framework/java-operator-sdk

Pull request overview

Adds contributor/agent guidance to ensure user-facing changes are reflected in the Hugo documentation, alongside a small documentation snippet tweak and an update to ignored local tooling files.

Changes:

  • Added a “Documentation Update” section to AGENTS.md describing when/where to update docs and basic guidelines.
  • Tweaked a Java cleanup example snippet formatting in the reconciler documentation.
  • Updated .gitignore to ignore a local .claude/ directory.

Reviewed changes

Copilot reviewed 1 out of 3 changed files in this pull request and generated 1 comment.

File Description
docs/content/en/docs/documentation/reconciler.md Updates the cleanup code snippet formatting in reconciler docs.
AGENTS.md Adds documentation-update guidance for contributors/agents (where to edit docs, when to update, and guidelines).
.gitignore Ignores .claude/ local directory.