Skip to content

Commit 82d1ea8

Browse files
docs: clarify Windows shell API key commands (#1730)
* docs: clarify Windows shell API key commands * Update Python and TS pages for consistency * Simplify lychee config, extend retry wait time --------- Co-authored-by: Kristopher Overholt <koverholt@google.com>
1 parent 00c0455 commit 82d1ea8

6 files changed

Lines changed: 56 additions & 14 deletions

File tree

.github/workflows/link-checker.yaml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,6 @@ jobs:
3232
args: >-
3333
--verbose
3434
--no-progress
35-
--max-retries 5
36-
--retry-wait-time 3
37-
--host-concurrency 2
38-
--host-request-interval 1s
3935
--root-dir "$(pwd)/docs"
4036
'./**/*.md'
4137
fail: true

docs/get-started/go.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,12 +117,18 @@ your project to set environment variables:
117117
echo 'export GOOGLE_API_KEY="YOUR_API_KEY"' > .env
118118
```
119119

120-
=== "Windows"
120+
=== "Windows PowerShell"
121121

122122
```console title="Update: my_agent/env.bat"
123123
echo 'set GOOGLE_API_KEY="YOUR_API_KEY"' > env.bat
124124
```
125125

126+
=== "Windows Command Prompt"
127+
128+
```console title="Update: my_agent/env.bat"
129+
echo set GOOGLE_API_KEY="YOUR_API_KEY" > env.bat
130+
```
131+
126132
??? tip "Using other AI models with ADK"
127133
ADK supports the use of many generative AI models. For more
128134
information on configuring other models in ADK agents, see

docs/get-started/java.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,12 +166,18 @@ to set environment variables:
166166
echo 'export GOOGLE_API_KEY="YOUR_API_KEY"' > .env
167167
```
168168

169-
=== "Windows"
169+
=== "Windows PowerShell"
170170

171171
```console title="Update: my_agent/env.bat"
172172
echo 'set GOOGLE_API_KEY="YOUR_API_KEY"' > env.bat
173173
```
174174

175+
=== "Windows Command Prompt"
176+
177+
```console title="Update: my_agent/env.bat"
178+
echo set GOOGLE_API_KEY="YOUR_API_KEY" > env.bat
179+
```
180+
175181
??? tip "Using other AI models with ADK"
176182
ADK supports the use of many generative AI models. For more
177183
information on configuring other models in ADK agents, see

docs/get-started/python.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ pip install google-adk
2424

2525
Activate the Python virtual environment:
2626

27-
=== "Windows CMD"
27+
=== "Windows Command Prompt"
2828

2929
```console
3030
.venv\Scripts\activate.bat
3131
```
3232

33-
=== "Windows Powershell"
33+
=== "Windows PowerShell"
3434

3535
```console
3636
.venv\Scripts\Activate.ps1
@@ -94,9 +94,23 @@ don't already have Gemini API key, create a key in Google AI Studio on the
9494

9595
In a terminal window, write your API key into an `.env` file as an environment variable:
9696

97-
```console title="Update: my_agent/.env"
98-
echo 'GOOGLE_API_KEY="YOUR_API_KEY"' > .env
99-
```
97+
=== "MacOS / Linux"
98+
99+
```bash title="Update: my_agent/.env"
100+
echo 'GOOGLE_API_KEY="YOUR_API_KEY"' > .env
101+
```
102+
103+
=== "Windows PowerShell"
104+
105+
```console title="Update: my_agent/.env"
106+
echo 'GOOGLE_API_KEY="YOUR_API_KEY"' > .env
107+
```
108+
109+
=== "Windows Command Prompt"
110+
111+
```console title="Update: my_agent/.env"
112+
echo GOOGLE_API_KEY="YOUR_API_KEY" > .env
113+
```
100114

101115
??? tip "Using other AI models with ADK"
102116
ADK supports the use of many generative AI models. For more

docs/get-started/typescript.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,23 @@ don't already have Gemini API key, create a key in Google AI Studio on the
8989
In a terminal window, write your API key into your `.env` file of your project
9090
to set environment variables:
9191

92-
```bash title="Update: my-agent/.env"
93-
echo 'GEMINI_API_KEY="YOUR_API_KEY"' > .env
94-
```
92+
=== "MacOS / Linux"
93+
94+
```bash title="Update: my-agent/.env"
95+
echo 'GEMINI_API_KEY="YOUR_API_KEY"' > .env
96+
```
97+
98+
=== "Windows PowerShell"
99+
100+
```console title="Update: my-agent/.env"
101+
echo 'GEMINI_API_KEY="YOUR_API_KEY"' > .env
102+
```
103+
104+
=== "Windows Command Prompt"
105+
106+
```console title="Update: my-agent/.env"
107+
echo GEMINI_API_KEY="YOUR_API_KEY" > .env
108+
```
95109

96110
??? tip "Using other AI models with ADK"
97111
ADK supports the use of many generative AI models. For more

lychee.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ exclude_loopback = true
1414
index_files = ["index.md", "index.html"]
1515
fallback_extensions = ["md"]
1616

17+
# Retry configuration
18+
max_retries = 5
19+
retry_wait_time = 5
20+
host_concurrency = 2
21+
host_request_interval = "1s"
22+
1723
# Exclude file paths from checking
1824
# Add paths here for directories containing partial/template files
1925
exclude_path = [

0 commit comments

Comments
 (0)