Skip to content

Commit d0404cd

Browse files
committed
[docs-agent] Clean up Docs Agent's README.md files.
1 parent 639f481 commit d0404cd

File tree

2 files changed

+18
-79
lines changed

2 files changed

+18
-79
lines changed

examples/gemini/python/docs-agent/README.md

Lines changed: 13 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ The following list summarizes the tasks and features supported by Docs Agent:
6767
to create, populate, update and delete online corpora using the Semantic Retrieval AI.
6868
For the list of all available Docs Agent command lines, see the
6969
[Docs Agent CLI reference][cli-reference] page.
70-
- **Run the Docs Agent CLI from anywhere on a terminal**: You can set up the
71-
Docs Agent CLI to ask questions to the Gemini model from anywhere on a terminal.
70+
- **Run the Docs Agent CLI from anywhere in a terminal**: You can set up the
71+
Docs Agent CLI to ask questions to the Gemini model from anywhere in a terminal.
7272
For more information, see the [Set up Docs Agent CLI][cli-readme] page.
7373

7474
For more information on Docs Agent's architecture and features,
@@ -174,41 +174,32 @@ Authorize Google Cloud credentials on your host machine:
174174
(`application_default_credentials.json`) in the `$HOME/.config/gcloud/`
175175
directory of your host machine.
176176

177-
### 4. Clone the Docs Agent project repository
177+
### 4. Clone the Docs Agent project
178178

179179
**Note**: This guide assumes that you're creating a new project directory
180180
from your `$HOME` directory.
181181

182-
Clone the Docs Agent repository and install dependencies:
182+
Clone the Docs Agent project and install dependencies:
183183

184-
1. Clone the following internal repo:
184+
1. Clone the following repo:
185185

186186
```posix-terminal
187-
git clone sso://doc-llm-internal/docs-agent
187+
git clone https://github.com/google/generative-ai-docs.git
188188
```
189189

190-
2. Go to the project directory:
190+
2. Go to the Docs Agent project directory:
191191

192192
```posix-terminal
193-
cd docs-agent
193+
cd generative-ai-docs/examples/gemini/python/docs-agent
194194
```
195195

196-
3. (**Optional**) If you plan on contributing to the `docs-agent` repo,
197-
run the following command to set up your commit hook:
198-
199-
```
200-
curl -Lo `git rev-parse --git-dir`/hooks/commit-msg https://gerrit-review.googlesource.com/tools/hooks/commit-msg ; chmod +x `git rev-parse --git-dir`/hooks/commit-msg
201-
```
202-
203-
4. Install dependencies using `poetry`:
196+
3. Install dependencies using `poetry`:
204197

205198
```posix-terminal
206199
poetry install
207200
```
208201

209-
This may take some time to complete.
210-
211-
5. Enter the `poetry` shell environment:
202+
4. Enter the `poetry` shell environment:
212203

213204
```posix-terminal
214205
poetry shell
@@ -234,7 +225,7 @@ Update settings in the Docs Agent project to use your custom dataset:
234225
1. Go to the Docs Agent project home directory, for example:
235226

236227
```
237-
cd $HOME/docs-agent
228+
cd $HOME/generative-ai-docs/examples/gemini/python/docs-agent
238229
```
239230

240231
2. Open the [`config.yaml`][config-yaml] file using a text editor, for example:
@@ -315,7 +306,7 @@ To populate a new vector database:
315306
1. Go to the Docs Agent project home directory, for example:
316307

317308
```
318-
cd $HOME/docs-agent
309+
cd $HOME/generative-ai-docs/examples/gemini/python/docs-agent
319310
```
320311

321312
2. Process Markdown files into small text chunks:
@@ -349,7 +340,7 @@ To start the Docs Agent chat app:
349340
1. Go to the Docs Agent project home directory, for example:
350341

351342
```
352-
cd $HOME/docs-agent
343+
cd $HOME/generative-ai-docs/examples/gemini/python/docs-agent
353344
```
354345

355346
2. Launch the Docs Agent chat app:
@@ -391,56 +382,6 @@ To start the Docs Agent chat app:
391382

392383
**The Docs Agent chat app is all set!**
393384

394-
## Contribute to Docs Agent
395-
396-
The section provides instructions on how to set up your account with the Docs Agent
397-
repository so that you can start contributing to the Docs Agent project.
398-
399-
To set up your account for the Docs Agent repository, do the following:
400-
401-
1. To create an account on Gerrit Code Review, open the following page
402-
on a browser:
403-
404-
```
405-
https://doc-llm-internal-review.git.corp.google.com/
406-
```
407-
408-
1. Click **Create account**.
409-
410-
1. Clone the `docs-agent` repository on your host machine:
411-
412-
```
413-
git clone sso://doc-llm-internal/docs-agent
414-
```
415-
416-
1. Go to the project directory:
417-
418-
```
419-
cd docs-agent
420-
```
421-
422-
1. To set up your commit hook, run the following command:
423-
424-
```
425-
curl -Lo `git rev-parse --git-dir`/hooks/commit-msg https://gerrit-review.googlesource.com/tools/hooks/commit-msg ; chmod +x `git rev-parse --git-dir`/hooks/commit-msg
426-
```
427-
428-
1. Create a new Gerrit change, for example:
429-
430-
```
431-
git add <files>
432-
```
433-
434-
```
435-
git commit [--amend]
436-
```
437-
438-
1. Upload the change for review:
439-
440-
```
441-
git push origin HEAD:refs/for/main
442-
```
443-
444385
## Contributors
445386

446387
Nick Van der Auwermeulen (`@nickvander`), Rundong Du (`@rundong08`),

examples/gemini/python/docs-agent/docs_agent/interfaces/README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -116,21 +116,21 @@ credentials (via `gcloud`) stored on your host machine.
116116
(`application_default_credentials.json`) in the `$HOME/.config/gcloud/`
117117
directory of your host machine.
118118

119-
## 4. Clone the Docs Agent project repository
119+
## 4. Clone the Docs Agent project
120120

121121
**Note**: This guide assumes that you're creating a new project directory
122122
from your `$HOME` directory.
123123

124-
1. Clone the following internal repo:
124+
1. Clone the following repo:
125125

126126
```posix-terminal
127-
git clone sso://doc-llm-internal/docs-agent
127+
git clone https://github.com/google/generative-ai-docs.git
128128
```
129129

130-
2. Go to the project directory:
130+
2. Go to the Docs Agent project directory:
131131

132132
```posix-terminal
133-
cd docs-agent
133+
cd generative-ai-docs/examples/gemini/python/docs-agent
134134
```
135135

136136
3. Install dependencies using `poetry`:
@@ -139,8 +139,6 @@ from your `$HOME` directory.
139139
poetry install
140140
```
141141

142-
This may take some time to complete.
143-
144142
## 5. Set up an alias to the gemini command
145143

146144
**Note**: If your Docs Agent project is not cloned in the `$HOME` directory,

0 commit comments

Comments
 (0)