From debcda93bce3166273e5864bfab661fb9b363971 Mon Sep 17 00:00:00 2001 From: Bryan Morgan Date: Wed, 18 Mar 2026 20:15:49 -0400 Subject: [PATCH] fix(docs): resolve broken links in documentation This commit fixes the Lychee link checker errors in the pre-submit workflow by converting several absolute repository paths that resolve to the file system root during tests to correct relative paths. Also corrects the broken 'Terms and privacy' link in index.md. --- CONTRIBUTING.md | 4 ++-- README.md | 2 +- docs/cli/telemetry.md | 6 +++--- docs/index.md | 5 +++-- 4 files changed, 9 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eb733f2cec..66d01168cd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -409,7 +409,7 @@ To debug the CLI's React-based UI, you can use React DevTools. ``` Your running CLI application should then connect to React DevTools. - ![](/docs/assets/connected_devtools.png) + ![](./docs/assets/connected_devtools.png) ### Sandboxing @@ -505,7 +505,7 @@ code. ### Documentation structure -Our documentation is organized using [sidebar.json](/docs/sidebar.json) as the +Our documentation is organized using [sidebar.json](./docs/sidebar.json) as the table of contents. When adding new documentation: 1. Create your markdown file **in the appropriate directory** under `/docs`. diff --git a/README.md b/README.md index eaa6afa27b..f6b5bea845 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![License](https://img.shields.io/github/license/google-gemini/gemini-cli)](https://github.com/google-gemini/gemini-cli/blob/main/LICENSE) [![View Code Wiki](https://assets.codewiki.google/readme-badge/static.svg)](https://codewiki.google/github.com/google-gemini/gemini-cli?utm_source=badge&utm_medium=github&utm_campaign=github.com/google-gemini/gemini-cli) -![Gemini CLI Screenshot](/docs/assets/gemini-screenshot.png) +![Gemini CLI Screenshot](./docs/assets/gemini-screenshot.png) Gemini CLI is an open-source AI agent that brings the power of Gemini directly into your terminal. It provides lightweight access to Gemini, giving you the diff --git a/docs/cli/telemetry.md b/docs/cli/telemetry.md index 211d877071..2df10241ab 100644 --- a/docs/cli/telemetry.md +++ b/docs/cli/telemetry.md @@ -187,11 +187,11 @@ visualize your telemetry. Find this dashboard under **Google Cloud Monitoring Dashboard Templates** as "**Gemini CLI Monitoring**". -![Gemini CLI Monitoring Dashboard Overview](/docs/assets/monitoring-dashboard-overview.png) +![Gemini CLI Monitoring Dashboard Overview](../assets/monitoring-dashboard-overview.png) -![Gemini CLI Monitoring Dashboard Metrics](/docs/assets/monitoring-dashboard-metrics.png) +![Gemini CLI Monitoring Dashboard Metrics](../assets/monitoring-dashboard-metrics.png) -![Gemini CLI Monitoring Dashboard Logs](/docs/assets/monitoring-dashboard-logs.png) +![Gemini CLI Monitoring Dashboard Logs](../assets/monitoring-dashboard-logs.png) To learn more, see [Instant insights: Gemini CLI’s pre-configured monitoring dashboards](https://cloud.google.com/blog/topics/developers-practitioners/instant-insights-gemini-clis-new-pre-configured-monitoring-dashboards/). diff --git a/docs/index.md b/docs/index.md index 84d3c8fd2b..62f48af6b5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -118,14 +118,15 @@ Support, release history, and legal information. - **[FAQ](./resources/faq.md):** Answers to frequently asked questions. - **[Quota and pricing](./resources/quota-and-pricing.md):** Limits and billing details. -- **[Terms and privacy](./tos-privacy):** Official notices and terms. +- **[Terms and privacy](./resources/tos-privacy.md):** Official notices and + terms. - **[Troubleshooting](./resources/troubleshooting.md):** Common issues and solutions. - **[Uninstall](./resources/uninstall.md):** How to uninstall Gemini CLI. ## Development -- **[Contribution guide](/docs/contributing):** How to contribute to Gemini CLI. +- **[Contribution guide](../CONTRIBUTING.md):** How to contribute to Gemini CLI. - **[Integration testing](./integration-tests.md):** Running integration tests. - **[Issue and PR automation](./issue-and-pr-automation.md):** Automation for issues and pull requests.