improve: add documentation guidline for agents#3339
Merged
Conversation
Contributor
There was a problem hiding this comment.
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.mddescribing when/where to update docs and basic guidelines. - Tweaked a Java
cleanupexample snippet formatting in the reconciler documentation. - Updated
.gitignoreto 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. |
Comment on lines
+101
to
105
| public DeleteControl cleanup(MyCustomResource customResource,Context context) { | ||
| // omitted code | ||
|
|
||
| return DeleteControl.defaultDelete(); | ||
| return DeleteControl.defaultDelete(); | ||
| } |
xstefank
approved these changes
May 11, 2026
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
csviri
force-pushed
the
docs-guidline-for-agent
branch
from
6b7f89d to
a26c400
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Attila Mészáros a_meszaros@apple.com