29 Commits

Author SHA1 Message Date
Yuan Teoh
dd7b9de623 docs: add issue and pr triaging and SLO (#2257)
## Description

update docs to reflect triaging workflow and SLO

## PR Checklist

> Thank you for opening a Pull Request! Before submitting your PR, there
are a
> few things you can do to make sure it goes smoothly:

- [x] Make sure you reviewed

[CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md)
- [x] Make sure to open an issue as a

[bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose)
  before writing your code! That way we can discuss the change, evaluate
  designs, and agree on the general idea
- [x] Ensure the tests and linter pass
- [x] Code coverage does not decrease (if any source code was changed)
- [x] Appropriate docs were updated (if necessary)
- [x] Make sure to add `!` if this involve a breaking change

🛠️ Fixes #<issue_number_goes_here>
2026-01-09 19:21:41 +00:00
manuka rahul
c088d4ed42 ci: add link checker workflow (#2189)
This workflow prevents the links that are broken or 404 errors by
checking the documentation links during development and before merging
into the main code base. This ensures all project documentation (Readme
, contribution files) remains current and functional , proactively
addressing technical debt. Please note this is a resubmission of a
previous [PR](https://github.com/googleapis/genai-toolbox/pull/1756)
that was closed due to merge conflicts

---------

Co-authored-by: Twisha Bansal <58483338+twishabansal@users.noreply.github.com>
2025-12-24 15:20:10 +05:30
gRedHeadphone
ea9e2d12bd docs: update unit tests execute command (#2074)
## Description

update unit tests execute command in DEVELOPER.md to exclude integration
tests

## PR Checklist

- [x] Make sure you reviewed

[CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md)
- [ ] Make sure to open an issue as a

[bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose)
  before writing your code! That way we can discuss the change, evaluate
  designs, and agree on the general idea
- [x] Ensure the tests and linter pass
- [x] Code coverage does not decrease (if any source code was changed)
- [x] Appropriate docs were updated (if necessary)
- [x] Make sure to add `!` if this involve a breaking change

Co-authored-by: Averi Kitsch <akitsch@google.com>
2025-12-09 23:48:54 +00:00
Yuan Teoh
735cb760ea docs: update long lines and tables (#1952)
Update long lines and tables formatting in markdown doc files.
2025-11-14 20:25:49 +00:00
Averi Kitsch
22b5aca395 ci: add product specific automation (#1906)
## Description

Set up product specific automation

## PR Checklist

> Thank you for opening a Pull Request! Before submitting your PR, there
are a
> few things you can do to make sure it goes smoothly:

- [ ] Make sure you reviewed

[CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md)
- [ ] Make sure to open an issue as a

[bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose)
  before writing your code! That way we can discuss the change, evaluate
  designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
- [ ] Make sure to add `!` if this involve a breaking change

🛠️ Fixes #<issue_number_goes_here>
2025-11-13 20:19:06 +00:00
Dr. Strangelove
937608db3e docs: Update testing instructions for maintainers (#1812)
Added instructions for maintainers to trigger tests.
2025-10-30 15:21:57 +00:00
Wenxin Du
98f7ee2e36 docs: fix docs lint (#1677)
fix docs lint for release
2025-10-09 19:25:05 -04:00
dishaprakash
21ac98bc06 feat: Add configs and workflows for docs versioning (#1611)
## Description

---
This PR adds related configs and workflows required for document
versioning.

## PR Checklist

---
> Thank you for opening a Pull Request! Before submitting your PR, there
are a
> few things you can do to make sure it goes smoothly:

- [x] Make sure you reviewed

[CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md)
- [ ] Make sure to open an issue as a

[bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose)
before writing your code! That way we can discuss the change, evaluate
  designs, and agree on the general idea
- [x] Ensure the tests and linter pass
- [x] Code coverage does not decrease (if any source code was changed)
- [x] Appropriate docs were updated (if necessary)
- [x] Make sure to add `!` if this involve a breaking change

🛠️ Fixes #<issue_number_goes_here>
2025-10-07 01:28:49 +05:30
Dr. Strangelove
cec88ec8cb test(looker): Expand timeout on tests (#1637)
## Description

---
The timeout on the server was one minute, but the tests were sometimes
running longer. Made timeout 5 minutes.

> Should include a concise description of the changes (bug or feature),
it's
> impact, along with a summary of the solution

## PR Checklist

---
> Thank you for opening a Pull Request! Before submitting your PR, there
are a
> few things you can do to make sure it goes smoothly:

- [x] Make sure you reviewed

[CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md)
- [x] Make sure to open an issue as a

[bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose)
before writing your code! That way we can discuss the change, evaluate
  designs, and agree on the general idea
- [x] Ensure the tests and linter pass
- [x] Code coverage does not decrease (if any source code was changed)
- [x] Appropriate docs were updated (if necessary)
- [x] Make sure to add `!` if this involve a breaking change

🛠️ Fixes #1635
2025-10-06 12:30:59 -07:00
Yuan Teoh
3d8a041782 docs: fix docs linting (#1520) 2025-09-18 16:30:46 -07:00
Yuan Teoh
bf6831fdbe docs: add tools naming convention (#1414)
Add guidelines for MCP Toolbox tools naming properties: **tool name**
and **tool kind**.
2025-09-10 23:00:02 +00:00
Ajaykumar Yadav
c65c11af24 docs: fix typos across docs (#1154)
got some typos while reading the docs

Co-authored-by: Averi Kitsch <akitsch@google.com>
2025-08-14 21:42:04 +00:00
Yuan
c7fe3c7f38 docs: fix linting in docs (#749)
Fix long lines and table column width lints in docs.
2025-06-25 17:03:42 +00:00
Averi Kitsch
e1355660d4 chore: Update Developer and Contributing docs (#738)
Co-authored-by: Wenxin Du <117315983+duwenxin99@users.noreply.github.com>
2025-06-24 13:58:47 -07:00
Wenxin Du
1d658c3b14 docs: Add guide for writing integration tests (#737)
Detailed instruction for writing integration tests.
2025-06-23 09:36:46 -07:00
Wenxin Du
5d183b0efe ci: Enable label-controlled docs preview (#516)
Allow external contributors to preview doc changes
2025-06-11 17:33:36 -04:00
Yuan
9ecf1755ab docs: update render-heading hook (#649)
There's a `no such template "_default/_markup/td-render-heading.html"`
error when running `hugo server` locally. This is due to a breaking
change in [Hugo
v0.146.0](https://github.com/gohugoio/hugo/releases/tag/v0.146.0). This
PR updates the render-heading file according to
https://github.com/google/docsy/pull/2223.
2025-06-04 01:14:23 +00:00
Wenxin Du
1596f5d772 chore: Revert accidental push (#648) 2025-06-04 00:17:30 +00:00
duwenxin
594066f9f4 add docs preview instruction 2025-06-03 17:01:57 -07:00
Averi Kitsch
032b333961 docs: Add prebuilt tools documentation (#602)
Co-authored-by: trehanshakuntG <trehanshakunt@google.com>
Co-authored-by: Prerna Kakkar <prernakakkar@google.com>
Co-authored-by: prernakakkar-google <158031829+prernakakkar-google@users.noreply.github.com>
Co-authored-by: Yuan <45984206+Yuan325@users.noreply.github.com>
Co-authored-by: Yuan Teoh <yuanteoh@google.com>
2025-05-28 22:38:16 +00:00
Wenxin Du
01e089cc34 docs: Update testing instruction in DEVELPER.md (#556)
We have refactored our tests. Fix instruction in DEVELOPER.md to match
the latest setting.
2025-05-12 16:04:05 -04:00
Averi Kitsch
df31fa6680 docs: Add Dev Assist docs for AlloyDB (#546)
Co-authored-by: duwenxin <duwenxin@google.com>
2025-05-09 16:01:49 -04:00
Wenxin Du
52b09a67cb doc: Add local integration testing instruction (#449)
Instructions for external contributors to run integration test locally.
2025-04-17 14:39:47 -04:00
Twisha Bansal
cf967452e1 chore: rename sdk repo to mcp-toolbox-sdk-python (#423) 2025-04-09 23:19:56 +05:30
Yuan
460e9e19b4 docs: add docs to run unit tests (#388)
Add docs to run unit test on GitHub.
2025-04-03 11:31:12 -07:00
Jack Wotherspoon
06940f2d82 chore: update sdk reference in DEVELOPER.md (#317)
Was getting a 404 on link referencing SDK developer guide.

I think it is meant to point at
https://github.com/googleapis/genai-toolbox-langchain-python/blob/main/DEVELOPER.md
2025-03-05 16:45:46 -07:00
Twisha Bansal
74c032abdf docs: fix link to sdk developer file (#67) 2024-11-13 11:59:02 +05:30
Twisha Bansal
4cf3a04b57 docs(llamaindex-sdk): add README for LlamaIndex SDK (#53)
Added LlamaIndex SDK docs

And corrected README to include LLamaIndex SDKs

---------

Co-authored-by: Kurtis Van Gent <31518063+kurtisvg@users.noreply.github.com>
2024-11-11 17:20:21 +00:00
Yuan
4f0335a733 docs: add developer.md (#29) 2024-10-31 12:03:22 -07:00