fix: broken links #2549
fix: broken links #2549
Conversation
|
The latest Buf updates on your PR. Results from workflow CI and Release / buf-check (pull_request).
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @Manav-Aggarwal, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
I've addressed an issue where several internal links within the documentation were broken due to an incorrect path prefix. My changes involve systematically removing the /docs segment from these links, ensuring that all references correctly point to their intended destinations. This improves the overall navigability and user experience of the documentation.
Highlights
- Documentation Link Fixes: I have updated various internal links across the documentation by removing the
/docsprefix. This change ensures that all internal navigation within the documentation works correctly, as the base path for the documentation seems to have changed or was incorrectly referenced.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
|
There was a problem hiding this comment.
Code Review
This pull request aims to fix broken links across the documentation by removing the /docs prefix from URL paths. While the changes made are correct, the fix is incomplete as many links still use the old path format. I've left specific comments on the changed files pointing out some missed instances. However, a more thorough check across the entire docs directory is needed to ensure all links are updated. For example, files like docs/guides/gm-world.md, docs/learn/specs/overview.md, and docs/learn/about.md were not part of this PR but still contain old links that need to be fixed.
| ``` | ||
|
|
||
| Now that you are in the docker container, you can interact with the chain using the `gmd` command and the example you used in the [gm-world tutorial](/docs/guides/gm-world.md). | ||
| Now that you are in the docker container, you can interact with the chain using the `gmd` command and the example you used in the [gm-world tutorial](/guides/gm-world.md). |
There was a problem hiding this comment.
Thanks for fixing this link. I noticed a couple of other links in this file were missed. For example, on lines 3 and 20, the links still use the old /docs/... path. It would be great to fix all of them in this file for consistency.
| - [Single Sequencer Setup Guide](/guides/evm/single.md) - Step-by-step deployment instructions | ||
| - [RETH Backup Guide](/guides/evm/reth-backup.md) - Data protection and backup procedures | ||
| - [Celestia DA Guide](/guides/da/celestia-da.md) - Connecting to Celestia networks |
There was a problem hiding this comment.
Good catch on these links. I noticed that the link on line 307, just below this list, appears to have been missed. It still points to /docs/guides/deploy/local.md and should probably be updated to /guides/deploy/local.md to align with the other changes in this PR.
|
Claude finished @Manav-Aggarwal's task —— View job Code Review ResultsReviewing this PR that fixes broken documentation links by removing the Review Tasks:
📋 Code Review SummaryThis PR addresses broken internal documentation links by removing the ✅ What Was Fixed Well
❌ Missed Links - Critical IssuesIn Modified Files:
Additional Issues Found: Notable files with broken links:
🔒 Security Considerations✅ No security issues - this is documentation-only changes ⚡ Performance Considerations✅ No performance impact - documentation changes only 🧪 Test Coverage✅ No test changes needed - documentation fixes don't require tests 📝 Code Quality Assessment
💡 Recommendations
🔧 Suggested Fix Command# Find all internal /docs/ links that need fixing
grep -r "(\|]()/docs/" docs/ --include="*.md" This is a good start, but a more comprehensive approach is needed to fully resolve the documentation linking issues across the entire project. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2549 +/- ##
=======================================
Coverage 74.48% 74.48%
=======================================
Files 70 70
Lines 6711 6711
=======================================
Hits 4999 4999
Misses 1315 1315
Partials 397 397
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
2 participants
Overview
Fixes some broken links