Skip to content

Commit

Permalink
chore: make docs public (#274)
Browse files Browse the repository at this point in the history
  • Loading branch information
kurtisvg authored Feb 6, 2025
1 parent 59b4282 commit cd4b35e
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 13 deletions.
4 changes: 1 addition & 3 deletions .github/workflows/docs_deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,7 @@ jobs:
- run: npm ci
- run: hugo --minify
env:
# HUGO_BASEURL: https://${{ github.repository_owner }}.github.io/${{ github.repository }}
# While private, GitHub uses an obfuscated url instead:
HUGO_BASEURL: https://vigilant-guacamole-plnwrm9.pages.github.io/
HUGO_BASEURL: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/
HUGO_RELATIVEURLS: false

- name: Deploy
Expand Down
6 changes: 2 additions & 4 deletions .github/workflows/docs_preview_deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,7 @@ jobs:
- run: npm ci
- run: hugo --minify
env:
# HUGO_BASEURL: https://${{ github.repository_owner }}.github.io/${{ github.repository }}/previews/PR-${{ github.event.number }}/
# While private, GitHub uses an obfuscated url instead:
HUGO_BASEURL: https://vigilant-guacamole-plnwrm9.pages.github.io/previews/PR-${{ github.event.number }}/
HUGO_BASEURL: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/previews/PR-${{ github.event.number }}/
HUGO_ENVIRONMENT: preview
HUGO_RELATIVEURLS: false

Expand All @@ -91,5 +89,5 @@ jobs:
issue_number: context.payload.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: "🔎 Preview at https://vigilant-guacamole-plnwrm9.pages.github.io/previews/PR-${{ github.event.number }}/"
body: "🔎 Preview at https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/previews/PR-${{ github.event.number }}/"
})
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ tools easier, faster, and more securely by handling the complexities such as
connection pooling, authentication, and more.

This README provides a brief overview. For comprehensive details, see the full
[documentation](https://vigilant-guacamole-plnwrm9.pages.github.io/).
[documentation](https://googleapis.github.io/genai-toolbox/).

<!-- TOC ignore:true -->
## Table of Contents
Expand Down Expand Up @@ -119,7 +119,7 @@ terminate signal (`ctrl+c` on most platforms).

For more detailed documentation on deploying to different environments, check
out the resources in the [How-to
section](https://vigilant-guacamole-plnwrm9.pages.github.io/how-to/)
section](https://googleapis.github.io/genai-toolbox/how-to/)

### Integrating your application

Expand Down Expand Up @@ -157,7 +157,7 @@ have multiple files, you can tell toolbox which to load with the `--tools_file
tools.yaml` flag.

You can find more detailed reference documentation to all resource types in the
[Resources](https://vigilant-guacamole-plnwrm9.pages.github.io/resources/).
[Resources](https://googleapis.github.io/genai-toolbox/resources/).
### Sources

The `sources` section of your `tools.yaml` defines what data sources your
Expand All @@ -176,7 +176,7 @@ sources:
```
For more details on configuring different types of sources, see the
[Sources](https://vigilant-guacamole-plnwrm9.pages.github.io/resources/sources/.
[Sources](https://googleapis.github.io/genai-toolbox/resources/sources/.
### Tools
Expand All @@ -198,7 +198,7 @@ tools:
```

For more details on configuring different types of tools, see the
[Tools](https://vigilant-guacamole-plnwrm9.pages.github.io/resources/tools).
[Tools](https://googleapis.github.io/genai-toolbox/resources/tools).


### Toolsets
Expand Down
2 changes: 1 addition & 1 deletion docs/en/resources/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
title: "Resources"
type: docs
weight: 4
description: List of reference documentation for resources in Toolbox
description: List of reference documentation for resources in Toolbox.
---

0 comments on commit cd4b35e

Please sign in to comment.