docs: improve clarity, active language, and add Google Analytics#43
Open
AaronForinton wants to merge 21 commits intomainfrom
Open
docs: improve clarity, active language, and add Google Analytics#43AaronForinton wants to merge 21 commits intomainfrom
AaronForinton wants to merge 21 commits intomainfrom
Conversation
# Conflicts: # src/poly/docs/docs/tutorials/build-an-agent.md
# Conflicts: # docs/docs/tutorials/build-an-agent.md
- Remove AI-isms: "heavy lifting", "trust the model", "composable", passive agent-speak - Use active, task-oriented language throughout (headers, instructions, tips) - Remove internal history paragraph from what-is-the-adk (Local Agent Studio provenance) - Add Python 3.14 install guidance and checklist to prerequisites - Add standard uv install command (astral.sh) to prerequisites - Remove "Running tests" from installation.md (belongs in testing.md) - Add `uv run pytest` variant to testing.md - Remove low-value Summary table from build-an-agent tutorial - Make VS Code extension a proper hyperlink in tooling.md - Fix "Pre-requisites" → "Prerequisites" across index and access pages - Clarify import line note in functions.md - Improve CLI reference lead paragraph Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
- Remove all remaining "coding agent" → "coding tool" across build-an-agent.md and development/docs.md - Rewrite development/docs.md fully: remove Summary table with fake metrics, update all step headings and body copy - Fix typo "walkthroug" in walkthrough-video.md - Fix "lets the model refer" in sms.md → plain language - Fix "This helps the model understand" in functions.md → "This tells the model when to call the function" - Fix passive constructions in experimental_config.md - Improve response_control.md lead sentence - Remove "virtual resources" jargon from variables.md lead - Fix "Loading ADK rules into your coding agent" heading in tooling.md Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
AaronForinton
changed the title
Also fix nav label "Pre-requisites" → "Prerequisites". Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
…m dashes - Replace bare pip install in Installation page with uv venv guidance - Add Generate API Key section (POLY_ADK_KEY) to Installation page - Remove Development setup from source from Installation page - Move Development setup from source to Working locally page - Remove pytest references from testing.md (users should use their own testing tools) - Replace em dashes with regular dashes across all docs pages Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
Contributor
Coverage Report
Changed file coverage
|
…t, fix em dashes" This reverts commit 3e5f00b.
bplevin36
reviewed
Mar 30, 2026
bplevin36
reviewed
Mar 30, 2026
bplevin36
reviewed
Mar 30, 2026
bplevin36
reviewed
Mar 30, 2026
bplevin36
reviewed
Mar 30, 2026
bplevin36
reviewed
Mar 30, 2026
bplevin36
reviewed
Mar 30, 2026
Comment on lines
+35
to
+37
| - **Homebrew** (macOS): `brew install [email protected]` | ||
| - **pyenv**: `pyenv install 3.14` then `pyenv global 3.14` | ||
| - **Official installer**: [python.org/downloads](https://www.python.org/downloads/){ target="_blank" rel="noopener" } |
Contributor
There was a problem hiding this comment.
like I said, we're recommending using uv, so we should remove all these other recommendations of how to install python
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
2 participants
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.
Summary
what-is-the-adk.md— not useful for external developersuvinstall command (astral.sh), and a proper checklisttesting.md, not install)uv run pytestas the canonical invocationfunctions.mdnow explains the consequence of modifying itTest plan
🤖 Generated with Claude Code