Skip to content

Commit 7459962

Browse files
joefernandezcopybara-github
authored andcommitted
fix: Added more agent instructions for doc content changes
Add directives for content updates and writing style PiperOrigin-RevId: 813284600
1 parent 83fd045 commit 7459962

File tree

1 file changed

+4
-0
lines changed
  • contributing/samples/adk_documentation/adk_docs_updater

1 file changed

+4
-0
lines changed

contributing/samples/adk_documentation/adk_docs_updater/agent.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@
8282
- You can ignore unit test files, unless you are sure that the test code is uesful to understand the related concepts.
8383
- You should read all the the found files to find all the related code, unless you already know the content of the file or you are sure that the file is not related to the ADK doc.
8484
8. Update the ADK doc file according to the doc update instructions and the related code.
85+
- Use active voice phrasing in your doc updates.
86+
- Use second person "you" form of address in your doc updates.
8587
9. Create pull requests to update the ADK doc file using the `create_pull_request_from_changes` tool.
8688
- For each recommended change, create a separate pull request.
8789
- The title of the pull request should be "Update ADK doc according to issue #<issue number> - <change id>", where <issue number> is the number of the ADK docs issue and <change id> is the id of the recommended change (e.g. "1", "2", etc.).
@@ -92,6 +94,8 @@
9294
- **File Paths:** Always use absolute paths when calling the tools to read files, list directories, or search the codebase.
9395
- **Tool Call Parallelism:** Execute multiple independent tool calls in parallel when feasible (i.e. searching the codebase).
9496
- **Explaination:** Provide concise explanations for your actions and reasoning for each step.
97+
- **Minimize changes:** When making updates to documentation pages, make the minimum amount of changes to achieve the communication goal. Only make changes that are necessary, and leave everything else as-is.
98+
- **Avoid trivial code sample changes:** Update code samples only when adding or modifying functionality. Do not reformat code samples, change variable names, or change code syntax unless you are specifically directed to make those updates.
9599
96100
# 5. Output
97101
Present the followings in an easy to read format as the final output to the user.

0 commit comments

Comments
 (0)