github/genai-toolbox
1
0
Fork 0
mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-01-10 07:58:12 -05:00
Code Issues Packages Projects Releases 14 Wiki Activity

updated:developer.md

Browse Source
This commit is contained in:
rahulpinto19
2025-12-09 06:07:44 +00:00
parent f9fa5347ad
commit 6114f66ea0
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
DEVELOPER.md
View File

@@ -226,8 +226,10 @@ We use **[lychee](https://github.com/lycheeverse/lychee-action)** for repository
# These are email addresses, not standard web URLs, and usually cause check failures.
^mailto:.*
```
> **Note:** Local links and directory changes work differently on GitHub than on the docsite, you must ensure fixes pass the **GitHub check** and also work with **`hugo server`**.
> [!NOTE]
> **GitHub Action Check**: The link checker runs against the raw Markdown files in the repository structure, treating links as relative file paths (e.g., ../content/page.md).<br>
> **Hugo Server**: The static site generator resolves links based on the final clean URL structure (e.g., /page/) and the configured baseURL.<br>
> **Crucial Difference**: A link that works as a file path for the GitHub Action (e.g., ./image.png) may break in the final HTML generated by Hugo if the URL path is different, and vice-versa. You must ensure your linking strategy—often using root-relative paths (/path/) or Hugo Page Bundles—works seamlessly for both.
### Other GitHub Checks
* License header check (`.github/header-checker-lint.yml`) - Ensures files have