-
Notifications
You must be signed in to change notification settings - Fork 58
fix: learn links #584
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: learn links #584
Conversation
WalkthroughThe changes update navigation and internal documentation links by replacing references to "/learn/intro" with "/learn/about" in both the site configuration and the main documentation index. No other structural or content modifications are introduced. Changes
Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @pthmas, 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!
This pull request addresses broken links on the 'learn' page and the main homepage. Following a previous merge that consolidated 'intro' and 'overview' content, the hardcoded links were no longer valid. My changes ensure that all relevant links now correctly point to the /learn/overview
page, restoring proper navigation and content access.
Highlights
- Navigation Link Update: I've updated the 'Learn' link in the main navigation bar to point to
/learn/overview
instead of/learn/intro
. - Homepage Content Link Correction: I've corrected two instances of the 'Introduction' link on the homepage (
index.md
) to now point to/learn/overview
.
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 is currently in preview and 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 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request addresses broken links by replacing the outdated /learn/intro
path with /learn/overview
. The changes are applied consistently in the VitePress navigation configuration (.vitepress/config.ts
) and the main marketing page (index.md
). The modifications are straightforward and correctly implement the described fix. The changes look good and I have no further suggestions.
|
7f9042e
to
f04f66b
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
index.md (1)
14-20
: Button text vs. target mismatchNow that the target page is “About”, consider renaming the button label from “Introduction” to “About” for consistency and to avoid user confusion.
- text: Introduction + text: About
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.vitepress/config.ts
(1 hunks)index.md
(2 hunks)
🔇 Additional comments (2)
.vitepress/config.ts (1)
172-178
: No leftover/learn/intro
links found
Ranrg -n "/learn/intro"
against the repo and got zero matches. The updated nav entry can be safely merged.index.md (1)
30-33
: Link fix acknowledgedThe feature card now routes to a valid page; no further issues spotted.
f04f66b
to
e3e4c75
Compare
Overview
Since I merged the intro and overview pages, the links were no longer valid. This PR fixes the links.
Summary by CodeRabbit