Skip to content

Commit 322dd18

Browse files
Goodnight77seanzhougoogle
authored andcommitted
docs: Fix typos, broken links, and grammar across documentation
Merge #3937 **Please ensure you have read the [contribution guide](https://github.com/google/adk-python/blob/main/CONTRIBUTING.md) before creating a pull request.** ### Link to Issue or Description of Change Not applicable **Problem:** Several markdown files contained typos, grammatical errors (e.g., "search youtubes"), and awkward phrasing. **Solution:** Performed a comprehensive quality assurance pass on the documentation. - Fixed typos in README.md and AGENTS.md. - Improved grammar and phrasing in CONTRIBUTING.md and sample READMEs. ### Testing Plan This is a documentation and typo fix PR. **Unit Tests:** - [ ] I have added or updated unit tests for my change. - [ ] All unit tests pass locally. N/A - Documentation changes only. **Manual End-to-End (E2E) Tests:** This is a documentation and typo fix PR. ### Checklist - [x] I have read the [CONTRIBUTING.md](https://github.com/google/adk-python/blob/main/CONTRIBUTING.md) document. - [x] I have performed a self-review of my own code. - [ ] I have commented my code, particularly in hard-to-understand areas. - [ ] I have added tests that prove my fix is effective or that my feature works. - [ ] New and existing unit tests pass locally with my changes. - [x] I have manually tested my changes end-to-end. - [ ] Any dependent changes have been merged and published in downstream modules. Co-authored-by: Xiang (Sean) Zhou <seanzhougoogle@google.com> COPYBARA_INTEGRATE_REVIEW=#3937 from Goodnight77:docs/fix-typos a0cf4db PiperOrigin-RevId: 845599254
1 parent 42317f8 commit 322dd18

File tree

9 files changed

+24
-19
lines changed

9 files changed

+24
-19
lines changed

CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
### Features
66
* **[Interactions API Support]**
7-
* The newly released Gemini [Interactions API](https://ai.google.dev/gemini-api/docs/interactions) is supported in ADK Now. To use it:
7+
* The newly released Gemini [Interactions API](https://ai.google.dev/gemini-api/docs/interactions) is supported in ADK now. To use it:
88
```Python
99
Agent(
1010
model=Gemini(
@@ -352,7 +352,7 @@
352352

353353
* Returns dict as result from McpTool to comply with BaseTool expectations ([4df9263](https://github.com/google/adk-python/commit/4df926388b6e9ebcf517fbacf2f5532fd73b0f71))
354354
* Fixes the identity prompt to be one line ([7d5c6b9](https://github.com/google/adk-python/commit/7d5c6b9acf0721dd230f08df919c7409eed2b7d0))
355-
* Fix the broken langchain importing caused their 1.0.0 release ([c850da3](https://github.com/google/adk-python/commit/c850da3a07ec1441037ced1b654d8aacacd277ab))
355+
* Fix the broken langchain importing caused by their 1.0.0 release ([c850da3](https://github.com/google/adk-python/commit/c850da3a07ec1441037ced1b654d8aacacd277ab))
356356
* Fix BuiltInCodeExecutor to support visualizations ([ce3418a](https://github.com/google/adk-python/commit/ce3418a69de56570847d45f56ffe7139ab0a47aa))
357357
* Relax runner app-name enforcement and improve agent origin inference ([dc4975d](https://github.com/google/adk-python/commit/dc4975dea9fb79ad887460659f8f397a537ee38f))
358358
* Improve error message when adk web is run in wrong directory ([4a842c5](https://github.com/google/adk-python/commit/4a842c5a1334c3ee01406f796651299589fe12ab))
@@ -629,7 +629,7 @@
629629
### Documentation
630630

631631
* Clean up docs in sample [a360bc2](https://github.com/google/adk-python/commit/a360bc25429bf4bef6a80da59afe30d6933a844b)
632-
* Fixes root_agent.yaml in tool_mcp_stdio_notion_config for Agent Config sample and add README.md [2c088ac](https://github.com/google/adk-python/commit/2c088acc9b34f030537b02b45a4afd458445d15b)
632+
* Fixes root_agent.yaml in tool_mcp_stdio_notion_config for Agent Config sample and adds README.md [2c088ac](https://github.com/google/adk-python/commit/2c088acc9b34f030537b02b45a4afd458445d15b)
633633
* Add What's new section to README.md [ccab076](https://github.com/google/adk-python/commit/ccab076aceff917591eb3a3cc89a9f85226b832a)
634634

635635
## 1.12.0 (2025-08-21)

CONTRIBUTING.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,14 +56,14 @@ information on using pull requests.
5656

5757
### Requirement for PRs
5858

59-
- All PRs, other than small documentation or typo fixes, should have a Issue
59+
- All PRs, other than small documentation or typo fixes, should have an Issue
6060
associated. If a relevant issue doesn't exist, please create one first or
6161
you may instead describe the bug or feature directly within the PR
6262
description, following the structure of our issue templates.
6363
- Small, focused PRs. Keep changes minimal—one concern per PR.
6464
- For bug fixes or features, please provide logs or screenshot after the fix
6565
is applied to help reviewers better understand the fix.
66-
- Please include a `testing plan` section in your PR to talk about how you
66+
- Please include a `testing plan` section in your PR to describe how you
6767
will test. This will save time for PR review. See `Testing Requirements`
6868
section for more details.
6969

@@ -126,7 +126,7 @@ Depending on your change:
126126

127127
For any changes that impact user-facing documentation (guides, API reference,
128128
tutorials), please open a PR in the
129-
[adk-docs](https://github.com/google/adk-docs) repository to update relevant
129+
[adk-docs](https://github.com/google/adk-docs) repository to update the relevant
130130
part before or alongside your code PR.
131131

132132
## Development Setup
@@ -160,7 +160,11 @@ part before or alongside your code PR.
160160
source .venv/bin/activate
161161
```
162162

163-
**windows** `shell source .\.venv\Scripts\activate`
163+
**Windows**
164+
165+
```shell
166+
source .\.venv\Scripts\activate
167+
```
164168

165169
4. **Install dependencies:**
166170

@@ -230,7 +234,7 @@ part before or alongside your code PR.
230234
## Contributing Resources
231235

232236
[Contributing folder](https://github.com/google/adk-python/tree/main/contributing)
233-
has resources that is helpful for contributors.
237+
has resources that are helpful for contributors.
234238

235239
## Vibe Coding
236240

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ of the ADK.
164164

165165
## Vibe Coding
166166

167-
If you are to develop agent via vibe coding the [llms.txt](./llms.txt) and the [llms-full.txt](./llms-full.txt) can be used as context to LLM. While the former one is a summarized one and the later one has the full information in case your LLM has big enough context window.
167+
If you want to develop agent via vibe coding the [llms.txt](./llms.txt) and the [llms-full.txt](./llms-full.txt) can be used as context to LLM. While the former one is a summarized one and the later one has the full information in case your LLM has big enough context window.
168168

169169
## Community Events
170170

contributing/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing Resources
22

3-
This folder host resources for ADK contributors, for example, testing samples etc.
3+
This folder hosts resources for ADK contributors, for example, testing samples etc.
44

55
## Samples
66

@@ -13,4 +13,4 @@ Samples folder host samples to test different features. The samples are usually
1313
The [adk_project_overview_and_architecture.md](adk_project_overview_and_architecture.md) describes the ADK project overview and its technical architecture from high-level.
1414

1515
This is helpful for contributors to understand the project and design philosophy.
16-
It can also be feed into LLMs for vibe-coding.
16+
It can also be fed into LLMs for vibe-coding.

contributing/adk_project_overview_and_architecture.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ my_adk_project/
3434
└── my_app/
3535
├── agents/
3636
│ ├── my_agent/
37-
│ │ ├── __init__.py # Must contain: from. import agent \
37+
│ │ ├── __init__.py # Must contain: from . import agent \
3838
│ │ └── agent.py # Must contain: root_agent = Agent(...) \
3939
│ └── another_agent/
4040
│ ├── __init__.py
@@ -43,7 +43,7 @@ my_adk_project/
4343

4444
agent.py: Must define the agent and assign it to a variable named root_agent. This is how ADK's tools find it.
4545

46-
`__init__.py`: In each agent directory, it must contain from. import agent to make the agent discoverable.
46+
`__init__.py`: In each agent directory, it must contain `from . import agent` to make the agent discoverable.
4747

4848
## Local Development & Debugging
4949

@@ -69,14 +69,15 @@ We expose agents as production APIs using FastAPI.
6969

7070
- Custom Endpoints: We can add our own routes (e.g., /health) to the app object returned by the helper.
7171

72-
Python
72+
```Python
7373

7474
from google.adk.cli.fast_api import get_fast_api_app
7575
app = get_fast_api_app(agent_dir="./agents")
7676

7777
@app.get("/health")
7878
async def health_check():
7979
return {"status": "ok"}
80+
```
8081

8182

8283
## Deployment to Production

contributing/samples/bigtable/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ type.
7272

7373
1. Follow https://developers.google.com/workspace/guides/configure-oauth-consent
7474
to add scope "https://www.googleapis.com/auth/bigtable.admin" and
75-
"https://www.googleapis.com/auth/bigtable.data" as declaration, this is used
75+
"https://www.googleapis.com/auth/bigtable.data" as a declaration, this is used
7676
for review purpose.
7777

7878
1. Follow

contributing/samples/langchain_youtube_search_agent/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Langchain YouTube Search Agent
22

3-
This agent utilize the Langchain YoutubeSearchTool to search youtubes.
4-
You need to install below dependencies:
3+
This agent utilizes the Langchain YoutubeSearchTool to search Youtube Videos.
4+
You need to install the following dependencies:
55

66
```python
77
uv pip install youtube_search

contributing/samples/live_bidi_streaming_single_agent/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Follow these steps to get the agent up and running:
88

99
1. **Start the ADK Web Server**
1010
Open your terminal, navigate to the root directory that contains the
11-
`live_bidi_streaming_agent` folder, and execute the following command:
11+
`live_bidi_streaming_single_agent` folder, and execute the following command:
1212
```bash
1313
adk web
1414
```

contributing/samples/mcp_streamablehttp_agent/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
This agent connects to a local MCP server via Streamable HTTP.
22

3-
To run this agent, start the local MCP server first by :
3+
To run this agent, start the local MCP server first by:
44

55
```bash
66
uv run filesystem_server.py

0 commit comments

Comments
 (0)