docs: fix broken README links and publish the constraints files
Co-authored-by: George Weale <gweale@google.com> PiperOrigin-RevId: 960406496
This commit is contained in:
committed by
Copybara-Service
parent
42f220a61b
commit
06111f127b
@@ -4,7 +4,7 @@
|
||||
[](https://pypi.org/project/google-adk/)
|
||||
[](https://pypi.org/project/google-adk/)
|
||||
[](https://pepy.tech/project/google-adk)
|
||||
[](https://github.com/google/adk-python/actions/workflows/python-unit-tests.yml)
|
||||
[](https://github.com/google/adk-python/actions/workflows/continuous-integration.yml)
|
||||
[](https://google.github.io/adk-docs/)
|
||||
|
||||
<h2 align="center">
|
||||
@@ -56,7 +56,7 @@ Choose the constraints file matching your Python version:
|
||||
|
||||
```bash
|
||||
# For example, for Python 3.10
|
||||
curl -o constraints-3.10.txt https://github.com/google/adk-python/blob/main/constraints-3.10.txt
|
||||
curl -o constraints-3.10.txt https://raw.githubusercontent.com/google/adk-python/main/constraints-3.10.txt
|
||||
pip install google-adk -c constraints-3.10.txt
|
||||
rm constraints-3.10.txt
|
||||
```
|
||||
@@ -121,8 +121,13 @@ adk web path/to/agents_dir
|
||||
## 📚 Documentation
|
||||
|
||||
- **Getting Started**: https://google.github.io/adk-docs/
|
||||
- **Samples**: See `contributing/workflow_samples/` and
|
||||
`contributing/task_samples/` for workflow and task API examples.
|
||||
- **Guides**: See
|
||||
[`docs/guides/`](https://github.com/google/adk-python/tree/main/docs/guides)
|
||||
for task-oriented walkthroughs of agents, tools, events, plugins, and
|
||||
workflows.
|
||||
- **Samples**: See
|
||||
[`contributing/samples/`](https://github.com/google/adk-python/tree/main/contributing/samples)
|
||||
for runnable example agents.
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@ To run this sample and actually log in, you need to:
|
||||
export GITHUB_CLIENT_ID="your_actual_client_id"
|
||||
export GITHUB_CLIENT_SECRET="your_actual_client_secret"
|
||||
```
|
||||
- Alternatively, you can create a `.env` file in the sample directory (`contributing/workflow_samples/auth_oauth/.env`) with the following content:
|
||||
- Alternatively, you can create a `.env` file in the sample directory (`contributing/samples/workflows/auth_oauth/.env`) with the following content:
|
||||
```env
|
||||
GITHUB_CLIENT_ID="your_actual_client_id"
|
||||
GITHUB_CLIENT_SECRET="your_actual_client_secret"
|
||||
@@ -102,11 +102,11 @@ Inside the node, we retrieve the token and use the `requests` library to call th
|
||||
To run this sample interactively, use the ADK CLI:
|
||||
|
||||
```bash
|
||||
adk run contributing/workflow_samples/auth_oauth
|
||||
adk run contributing/samples/workflows/auth_oauth
|
||||
```
|
||||
|
||||
Or use the Web UI:
|
||||
|
||||
```bash
|
||||
adk web contributing/workflow_samples/
|
||||
adk web contributing/samples/workflows/
|
||||
```
|
||||
|
||||
@@ -2,7 +2,10 @@
|
||||
|
||||
## Overview
|
||||
|
||||
This sample demonstrates how to define a workflow with a feedback loop using a YAML configuration file. It mirrors the `workflow_samples/loop` sample, but uses YAML to define the workflow structure instead of Python.
|
||||
This sample demonstrates how to define a workflow with a feedback loop using a
|
||||
YAML configuration file. It mirrors the
|
||||
`contributing/samples/workflows/loop` sample, but uses YAML to define the
|
||||
workflow structure instead of Python.
|
||||
|
||||
## Sample Inputs
|
||||
|
||||
|
||||
Reference in New Issue
Block a user